Installation

To install poromics, you can use pip, but we highly recommend using uv instead, as it is significantly faster. uv is a drop-in replacement for pip, so you can use it in the same way.

The LBM solvers (tortuosity_lbm, permeability_lbm) use Taichi, which is installed as a dependency. The Julia-based FD solver (tortuosity_fd) additionally requires Julia and Tortuosity.jl, which are installed automatically on first use.

Using uv

1. Install uv.
2. Create a virtual environment (or activate an existing one, e.g., conda or pyenv)
3. Run the following command in a terminal/command prompt:

uv pip install poromics

Using pip

1. Create a virtual environment (or activate an existing one, e.g., conda or pyenv)
2. Run the following command in a terminal/command prompt:

pip install poromics