lelou13 / pysces

Boundary element method for python

pysces: a boundary element solver for python

This python package implements a boundary element method for solving for the fluid flow around streamlined bodies moving in a potential flow.

Testing and coverage

Automated tests are provided, and may be run with:

$ python runtests.py

You can also generate a coverage report as follows:

$ coverage run runtests.py
$ coverage report -m

To generate a nice html report, use:

$ coverage html

and then open the files generated in the directory htmlcov/.

Coverage may be installed by executing:

$ pip install coverage

Documentation

The documentation is available online at http://pysces.readthedocs.org/ . Documentation is generated using sphinx and numpydoc. Once these are installed, you can build the documentation as follows:

$ cd doc
$ make html

The generated documentation will then be in the directory doc/_build/html.