PyLSMLIB

PyLSMLIB is a Python package that wraps the LSMLIB level set library using Cython. It arose out of the need to replace the rudimentary level set capability in FiPy with a faster C-based level set library. The interface is designed to be pythonic and match the interface to Scikit-fmm.

Hosted

<https://github.com/ktchu/LSMLIB.git/pylsmlib>

PyLSMLIB is hosted at Github in a subdirectory of LSMLIB.

Requirements

The main requirements are working versions of LSMLIB and Numpy. Cython should not be a requirement as the generated *.c files are included with the distribution. See requirements.txt for specific versions of dependencies used to run this package on the maintainer's system. The requirements.txt file is auto-generated so most of the packages listed are not necessarily required. However, if you are having issues with installation and missing packages this would be a good place to start looking.

Installation

The following should get you most of the way to an install.

$ pip install numpy

Clone the git repository.

$ git clone git://github.com/ktchu/LSMLIB.git LSMLIB

See the Github project page for further details. After cloning, install LSMLIB (consult LSMLIB's install if you have issues).

$ cd .../LSMLIB
$ mkdir build
$ cd build
$ ../configure
$ make
$ make install

To install PyLSMLIB.

$ cd .../LSMLIB/pylsmlib
$ python setup.py install

Testing

To run the tests

>>> import pylsmlib
>>> pylsmlib.test()

Documentation

To generate the PyLSMLIB documentation.

$ cd .../LSMLIB/pylsmlib/doc
$ make html