pixi.toml

[workspace]
name = "voids"
version = "0.1.11"
description = "Scientific Python package for digital porous media research"
channels = ["conda-forge"]
platforms = ["linux-64", "osx-arm64", "win-64"]

##########################################
########## Core dependencies #############
##########################################
[dependencies]
python = ">=3.11,<3.13"

[feature.core.dependencies]
numpy = "*"
scipy = "*"
edt = ">=3.0"
numba = ">=0.60"
scikit-image = ">=0.22"
tifffile = ">=2023.8"
h5py = ">=3.10"
typing_extensions = ">=4.10"
ipykernel = ">=7.2.0,<8"
tqdm = ">=4.67.3,<5"
plotly = ">=5.0"

[feature.core.pypi-dependencies]
voids = { path = ".", editable = true }
porespy = ">=2.4"
openpnm = ">=3.6,<3.7"
pyvista = ">=0.43"
kaleido = ">=0.2.1"
meshio = ">=5.3"

##########################################
####### Platform dependencies ############
##########################################

[target.linux-64.dependencies]
mkl = ">=2023"

[target.linux-64.pypi-dependencies]
pypardiso = ">=0.4"

[target.linux-64.activation.env]
UCX_TLS = "tcp,self"

##########################################
####### Features dependencies ############
##########################################

[feature.dev.dependencies]
ruff = ">=0.6"
mypy = ">=1.10"
pre-commit = ">=3.7"
ipython = ">=8.0"
jupyterlab = ">=4.0"
jupytext = ">=1.19.1,<2"
pandas = ">=3.0.1,<4"
zlib = ">=1.3.2,<2"

[feature.notebooks.dependencies]
ipython = ">=8.0"
jupyterlab = ">=4.0"
jupytext = ">=1.19.1,<2"

[feature.viz.dependencies]
vtk = "9.*"
trame = "3.*"
matplotlib-base = "*"

[feature.test.dependencies]
pytest = ">=8.0"
pytest-cov = ">=5.0"
pytest-regressions = ">=2.8"
networkx = ">=3.2"
diff-cover = "*"

[feature.lbm.pypi-dependencies]
xlb = ">=0.3,<0.4"
jax = ">=0.8,<0.10"

[feature.fem.dependencies]
fenics-dolfinx = ">=0.9,<0.11"

[feature.solvers.dependencies]
suitesparse = "*"
libumfpack = "*"
scikit-umfpack = "*"

[feature.solvers.pypi-dependencies]
pyamg = ">=5.3"

[feature.docs.dependencies]
ruff = ">=0.6"

[feature.docs.pypi-dependencies]
mkdocs = ">=1.5,<2.0"
mkdocs-material = ">=9.5"
mkdocstrings = {version = ">=0.25", extras = ["python"]}

[feature.thermo.pypi-dependencies]
coolprop = ">=6.6"
thermo = ">=0.6.0, <0.7"

[target.unix.activation.env]
PYTHONPATH = "$PIXI_PROJECT_ROOT/src${PYTHONPATH:+:$PYTHONPATH}"
VOIDS_PROJECT_ROOT = "$PIXI_PROJECT_ROOT"
VOIDS_NOTEBOOKS_PATH = "$PIXI_PROJECT_ROOT/notebooks"
VOIDS_EXAMPLES_PATH = "$PIXI_PROJECT_ROOT/examples"
VOIDS_DATA_PATH = "$PIXI_PROJECT_ROOT/examples/data"

[target.win.activation.env]
PYTHONPATH = "%PIXI_PROJECT_ROOT%\\src;%PYTHONPATH%"
VOIDS_PROJECT_ROOT = "%PIXI_PROJECT_ROOT%"
VOIDS_NOTEBOOKS_PATH = "%PIXI_PROJECT_ROOT%\\notebooks"
VOIDS_EXAMPLES_PATH = "%PIXI_PROJECT_ROOT%\\examples"
VOIDS_DATA_PATH = "%PIXI_PROJECT_ROOT%\\examples\\data"

[target.osx-arm64.activation.env]
FI_PROVIDER = "tcp"

[tasks]
lint = "ruff check src tests"
format-check = "ruff format --check src tests"
typecheck = "mypy"
test = "pytest -q -v"
test-lbm = "pytest -q tests/test_benchmark_xlb.py"
test-cov = "pytest --cov=voids --cov-report=term-missing"
test-cov-report = "pytest --cov=voids --cov-report=term-missing --cov-report=xml:coverage.xml"
spec-check = "pytest -q tests/test_schema_network.py"
examples-singlephase = "python -m voids.simulators.run_singlephase"
precommit = "pre-commit run --all-files"
crosscheck-roundtrip = "pytest -q tests/test_crosscheck_roundtrip.py"
notebooks-smoke = "python -c 'from pathlib import Path; n=sorted(Path(\"notebooks\").glob(\"*.ipynb\")); print(len(n), [p.name for p in n])'"
register-kernels = "pixi run -e default python -m ipykernel install --user --name voids-default --display-name 'voids (default)' && pixi run -e test python -m ipykernel install --user --name voids-test --display-name 'voids (test)'"
unregister-kernels = "python -m jupyter kernelspec uninstall -f voids-default voids-test"
bump-version = "python scripts/bump_version.py"
sync-deps = "python scripts/sync_deps.py"
sync-deps-check = "python scripts/sync_deps.py --check"
notebooks-sync = "python scripts/sync_notebooks.py"
precommit-sync = "python scripts/sync_notebooks.py && pre-commit run --all-files"
docs-build = "pixi run -e docs mkdocs build"
docs-serve = "pixi run -e docs mkdocs serve"

[feature.docs.activation.env]
NO_MKDOCS_2_WARNING = "1"

[environments]
default = { features = ["core", "dev", "viz", "notebooks", "thermo", "lbm", "fem", "solvers"], solve-group = "default" }
test = { features = ["core", "dev", "viz", "thermo", "lbm", "fem", "solvers", "test"], solve-group = "default" }
docs = { features = ["docs"], solve-group = "docs" }