Merge pull request openedx#23 from edx/ned/move-loncapa-etc-into-sandbox

Ned/move loncapa etc into sandbox
hyperstudio · Jun 3, 2013 · c865641 · c865641
2 parents c0859cb + 88d3f25
commit c865641
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 13 deletions.
diff --git a/common/lib/capa/symmath/README.md b/common/lib/capa/symmath/README.md
diff --git a/lms/lib/loncapa/__init__.py → .../lib/sandbox-packages/loncapa/__init__.py b/lms/lib/loncapa/__init__.py → .../lib/sandbox-packages/loncapa/__init__.py
diff --git a/lms/lib/loncapa/loncapa_check.py → ...sandbox-packages/loncapa/loncapa_check.py b/lms/lib/loncapa/loncapa_check.py → ...sandbox-packages/loncapa/loncapa_check.py
diff --git a/common/lib/sandbox-packages/setup.py b/common/lib/sandbox-packages/setup.py
@@ -4,6 +4,7 @@
     name="sandbox-packages",
     version="0.1.1",
     packages=[
+        "loncapa",
         "verifiers",
     ],
     py_modules=[

diff --git a/common/lib/symmath/setup.py b/common/lib/symmath/setup.py
@@ -0,0 +1,10 @@
+from setuptools import setup
+
+setup(
+    name="symmath",
+    version="0.1",
+    packages=["symmath"],
+    install_requires=[
+        "sympy",
+    ],
+)
diff --git a/common/lib/symmath/symmath/README.md b/common/lib/symmath/symmath/README.md
@@ -0,0 +1,30 @@
+(Originally written by Ike.)
+
+At a high level, the main challenges of checking symbolic math expressions are
+(1) making sure the expression is mathematically legal, and (2) simplifying the
+expression for comparison with what is expected.
+
+(1) Generation (and testing) of legal input is done by using MathJax to provide
+input math in an XML format known as Presentation MathML (PMathML).  Such
+expressions typeset correctly, but may not be mathematically legal, like "5 /
+(1 = 2)".  The PMathML is converted into "Content MathML" (CMathML), which is
+by definition mathematically legal, using an XSLT 2.0 stylesheet, via a module
+in SnuggleTeX. CMathML is then converted into a sympy expression.  This work is
+all done in `symmath/formula.py`.
+
+(2) Simplifying the expression and checking against what is expected is done by
+using sympy, and a set of heuristics based on options flags provided by the
+problem author.  For example, the problem author may specify that the expected
+expression is a matrix, in which case the dimensionality of the input
+expression is checked.  Other options include specifying that the comparison be
+checked numerically in addition to symbolically.  The checking is done in
+stages, first with no simplification, then with increasing levels of testing;
+if a match is found at any stage, then an "ok" is returned.  Helpful messages
+are also returned, eg if the input expression is of a different type than the
+expected.  This work is all done in `symmath/symmath_check.py`.
+
+Links:
+
+SnuggleTex: http://www2.ph.ed.ac.uk/snuggletex/documentation/overview-and-features.html
+MathML: http://www.w3.org/TR/MathML2/overview.html
+SymPy: http://sympy.org/en/index.html
diff --git a/common/lib/capa/symmath/__init__.py → common/lib/symmath/symmath/__init__.py b/common/lib/capa/symmath/__init__.py → common/lib/symmath/symmath/__init__.py
diff --git a/common/lib/capa/symmath/formula.py → common/lib/symmath/symmath/formula.py b/common/lib/capa/symmath/formula.py → common/lib/symmath/symmath/formula.py
diff --git a/common/lib/capa/symmath/symmath_check.py → common/lib/symmath/symmath/symmath_check.py b/common/lib/capa/symmath/symmath_check.py → common/lib/symmath/symmath/symmath_check.py
diff --git a/lms/lib/symmath/test_formula.py → common/lib/symmath/symmath/test_formula.py b/lms/lib/symmath/test_formula.py → common/lib/symmath/symmath/test_formula.py
diff --git a/lms/lib/symmath/test_symmath_check.py → ...lib/symmath/symmath/test_symmath_check.py b/lms/lib/symmath/test_symmath_check.py → ...lib/symmath/symmath/test_symmath_check.py
diff --git a/requirements/edx-sandbox/local.txt b/requirements/edx-sandbox/local.txt
@@ -4,3 +4,4 @@
 common/lib/calc
 common/lib/chem
 common/lib/sandbox-packages
+common/lib/symmath
diff --git a/requirements/edx/local.txt b/requirements/edx/local.txt
@@ -2,5 +2,6 @@
 -e common/lib/calc
 -e common/lib/capa
 -e common/lib/chem
+-e common/lib/symmath
 -e common/lib/xmodule
 -e .