Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added info that algopy is available as a NetBSD package

  • Loading branch information...
commit 34bb1e08695bd73dc677e872b9029e7dd237fa5e 1 parent ff2baee
Sebastian Walter authored
Showing with 36 additions and 25 deletions.
  1. +3 −16 README.rst
  2. +26 −7 documentation/sphinx/index.rst
  3. +7 −2 setup.py
View
19 README.rst
@@ -53,6 +53,9 @@ Example:
print 'Jacobian dy/dx =', J
+Installation:
+
+ see http://packages.python.org/algopy/
Features:
@@ -77,22 +80,6 @@ Testing:
$ python -c "import algopy; algopy.test()"
-Dependencies:
-
- ALGOPY Core:
- * numpy
- * scipy
-
- ALGOPY Examples:
- * pyadolc
-
- Run tests:
- * Nose
-
- Documentation:
- * sphinx
- * matplotlib, mayavi2, yapgvb
-
Alternatives:
If you are looking for a robust tool for AD in Python you should try:
View
33 documentation/sphinx/index.rst
@@ -170,24 +170,43 @@ AlgoPy has been influenced by the following publications:
Installation and Upgrade:
-------------------------
-Current version is 0.3.0
+Current version is 0.3.2
Official releases:
* available at: http://pypi.python.org/pypi/algopy
- * if you have easy_install you can use the shell command
+ * with pip
+ - `$ pip install algopy`
+ * with easy_install
- `$ easy_install algopy` for installation
- `$ easy_install --upgrade algopy` to upgrade to the newest version
+ * NetBSD package
+ `http://pkgsrc.se/wip/py-algopy`
+ `http://cvsweb.se.netbsd.org/cgi-bin/bsdweb.cgi/wip/py-algopy`
Bleeding edge:
- * the most recent version is available at `https://github.com/b45ch1/algopy` .
+ * the most recent version is available at `https://github.com/b45ch1/algopy`
* includes additional documentation, e.g. talks and additional examples and
the sphinx `*.rst` documents
+
Dependencies:
- * numpy
- * (optional/recommended) scipy (needed to support some linear algebra functions)
- * (optional/recommended) nose
- * (optional/recommended) yapgvb (to generate plots of the computational graph)
+
+ ALGOPY Core:
+ * numpy
+ * scipy
+
+ ALGOPY Examples:
+ * pyadolc
+
+ Run tests:
+ * Nose
+
+ Documentation:
+ * sphinx
+ * matplotlib, mayavi2, yapgvb
+
+
+
How does it work?:
------------------
View
9 setup.py
@@ -16,6 +16,11 @@
#
# python setup.py sdist --formats=gztar,zip upload
+# upload sphinx documentation
+# python setup.py build_sphinx
+# python setup.py upload_sphinx
+# need to uncomment some code for that (look for comments containging build_sphinx)
+
DOCLINES = __doc__.split("\n")
import os
@@ -138,7 +143,7 @@ def setup_package():
from distutils.core import setup
# from distutils.core import setup, Extension
- # from setuptools import setup
+ # from setuptools import setup #uncomment for build_sphinx and upload_sphinx
try:
setup(name=NAME,
@@ -154,7 +159,7 @@ def setup_package():
packages = packages,
# ext_package='algopy.ctps',
# ext_modules=[Extension('libctps', ['algopy/ctps/src/ctps.c'])],
- # entry_points = {"distutils.commands": ["upload_sphinx = sphinx_pypi_upload:UploadDoc",]}
+ # entry_points = {"distutils.commands": ["upload_sphinx = sphinx_pypi_upload:UploadDoc",]} #uncomment for build_sphinx and upload_sphinx
)
finally:
Please sign in to comment.
Something went wrong with that request. Please try again.