Metadata-Version: 2.4
Name: panta-rhei
Version: 0.7.2
Summary: Miscellaneous fenics/dolfin utilities that are used in various projects.
Author-email: Jørgen Riseth <jnriseth@gmail.com>
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: loguru
Requires-Dist: sympy
Requires-Dist: matplotlib
Requires-Dist: meshio[all]
Requires-Dist: numpy
Requires-Dist: gmsh
Dynamic: license-file

# Panta Rhei
A collection of utilities for fluid flow modelling using FeNICS.

Note: This package was originally Pantarei, but was renamed to Panta Rhei in a hurry to avoid conflicts with a package of the same name on PyPI. For backwards compatibility,  it is still imported as `pantarei`, but this will be changed in the future.

## Dependencies
The package depends on [FEniCS](https://fenicsproject.org/download/) and [SVMTK](https://github.com/SVMTK/SVMTK), which is not installed by default, since they are not available on PyPI. They are most easily installed using conda, by running the following commands: 
```bash
conda create -n fenicsproject -c conda-forge/label/fenics-dev  -c conda-forge fenics SVMTK h5py
conda activate fenicsproject
```
`h5py` should also be installed, or else there might be conflicts between the version of `h5py` that is installed with `fenics` and the one that is installed by `meshio` (listed as a pip-installable dependency).

## Installation
The panta-rhei package itself may be installed using `pip`,
```bash
pip install panta-rhei
```
or by cloning the repository and running the following command in the root directory:
```bash
pip install -e .
```
## Running tests
Tests depends on the Pixi, a python package manager tightly integrated with conda. It can be installed by running
```bash
curl -fsSL https://pixi.sh/install.sh | bash
```
The tests can be run by running the following command in the root directory:
```bash
pixi run test
```
For more information on Pixi see [https://pixi.sh/](https://pixi.sh/), or [this guide by Eric Ma](https://ericmjl.github.io/blog/2024/8/16/its-time-to-try-out-pixi).
