flowprog: procedural generation of material flow model

This Python package defines a framework for building up mass flow models using Sympy symbolic equations.

Getting started

Install flowprog -- it is not yet released on PyPI so this needs to be done locally or via git. This takes only a few seconds.

For example, using uv:

uv add https://github.com/probs-lab/flowprog/archive/refs/heads/main.zip

or using pip (with a suitable virtual environment activated):

pip install https://github.com/probs-lab/flowprog/archive/refs/heads/main.zip

See the documentation in docs/ for more details and examples.

Then install dependencies using uv:

uv sync

Build the documentation and examples using Jupyter Book:

uv run jb build docs

Then open the resulting HTML files in docs/_build/html/index.html in your browser.

Run the tests using pytest:

uv run pytest tests