Merge pull request #12 from algrs/master

Updates from Body Labs
mattloper · Apr 10, 2017 · f27e987 · f27e987
2 parents 91004f1 + 80bbdab
commit f27e987
Show file tree

Hide file tree

Showing 30 changed files with 1,308 additions and 628 deletions.
diff --git a/.gitignore b/.gitignore
@@ -52,3 +52,4 @@ coverage.xml
 # Sphinx documentation
 docs/_build/
 
+.DS_Store
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,5 @@
 global-include . *.py *.c *.h Makefile *.pyx 
-global-exclude optional_test_performance.py
+global-exclude chumpy/optional_test_performance.py
 prune dist
 
 
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ tidy:
 
 test:  clean qtest
 qtest:   all
-	python -m unittest discover
+	python -m unittest discover -s chumpy
 
 coverage: clean qcov
 qcov: all

diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
 chumpy
 ======
+
+Chumpy is a Python-based framework designed to handle the auto-differentiation problem, 
+which is to evalute an expression and its derivatives with respect to its inputs, with 
+the use of the chain rule. Chumpy is intended to make construction and local
+minimization of objectives easier. Specifically, it provides:
+
+- Easy problem construction by using Numpy’s application interface
+- Easy access to derivatives via auto differentiation
+- Easy local optimization methods (12 of them: most of which use the derivatives) 
+
+Chumpy comes with its own demos, which can be seen by typing the following::
+
+>> import chumpy
+>> chumpy.demo() # prints out a list of possible demos
+
+Licensing is specified in the attached LICENSE.txt.
+
diff --git a/README.txt b/README.txt
diff --git a/__init__.py → chumpy/__init__.py b/__init__.py → chumpy/__init__.py
@@ -6,6 +6,8 @@
 import testing
 from version import version as __version__
 
+from version import version as __version__
+
 from numpy import bool, int, float, complex, object, unicode, str, nan, inf
 
 def test():

diff --git a/api_compatibility.py → chumpy/api_compatibility.py b/api_compatibility.py → chumpy/api_compatibility.py