/multipy

multipy: Python library for multicomponent mass transfer

Primary LanguagePythonMIT LicenseMIT

Screenshot



Tutorials

Binder


Installation

Follow these instructions:

git clone https://github.com/kamilazdybal/multipy.git
cd multipy
python setup.py install

If the installation was successful, you should be able to run the unit tests:

python -m unittest discover

and Python should now allow you to:

import multipy

Local documentation build

To build the documentation locally first install the required libraries:

pip install sphinx
pip install jupyter-sphinx-theme

and then build the documentation:

cd docs
sphinx-build -b html . builddir
make html

To view the documentation in your web browser:

open _build/html/index.html