pixi.toml

[workspace]
name = "Parcels"
exclude-newer = "5d" # security pre-caution against compromised packages
preview = ["pixi-build"]
channels = ["conda-forge"]
platforms = ["win-64", "linux-64", "osx-64", "osx-arm64"]
requires-pixi = ">=0.82.1"

[exclude-newer]
pixi-build-python = "0d"

[package]
name = "parcels"
version = "dynamic" # dynamic versioning needs better support in pixi https://github.com/prefix-dev/pixi/issues/2923#issuecomment-2598460666 . Putting `version = "dynamic"` here for now until pixi recommends something else.

[package.build]
backend = { name = "pixi-build-python", version = "0.*" }

[package.host-dependencies]
setuptools = ">=77"
setuptools_scm = ">=8"


[package.run-dependencies] # keep section in sync with pyproject.toml dependencies
python = ">=3.11"
cf_xarray = ">=0.10.0"
cftime = ">=1.6.3"
dask = ">=2025.7.0"
netcdf4 = ">=1.6.0"
numpy = ">=2.3.0"
pandas = ">=2.3"
polars = ">=1.32.0"
pooch = ">=1.8.0"
pyarrow = ">=21.0.0"
tabulate = ">=0.9.0"
tqdm = ">=4.67.0"
uxarray = ">=2026.04.1"
xarray = ">=2025.8.0"
zarr = ">=3.1"


[dependencies]
parcels = { path = "." }

[feature.min-versions.dependencies]
python = "3.11.*"
cf_xarray = "0.10.*"
cftime = "1.6.*"
dask = "2025.7.*"
netcdf4 = "1.6.*"
numpy = "2.3.*"
pandas = "2.3.*"
polars = "1.32.*"
pooch = "1.8.*"
pyarrow = "21.0.*"
tabulate = "0.9.*"
tqdm = "4.67.*"
uxarray = "2026.04.*"
xarray = "2025.8.*"
zarr = "3.1.*"

[feature.py311.dependencies]
python = "3.11.*"

[feature.py313.dependencies]
python = "3.13.*"

[feature.test.dependencies]
nbval = "*"
pytest = "*"
hypothesis = "*"
pytest-html = "*"
pytest-cov = "*"
pytest-reportlog = "*"
pytest-timeout = "*"

[feature.test.pypi-dependencies]
re-assert = "*"

[feature.test.tasks]
tests = { cmd = "pytest", description = "Run the test suite." }
tests-flaky = { cmd = "pytest -m 'flaky' --run-flaky-tests", description = "Run only flaky tests." }
tests-validation = { cmd = "pytest -m 'validation' --run-validation-tests", description = "Run only validation tests." }
tests-notebooks = { cmd = "pytest --nbval-lax docs/user_guide/examples", description = "Run the user guide example notebooks as tests." }


[feature.notebooks.dependencies]
jupyter = "*"
matplotlib-base = ">=2.0.2"
gsw = "*"
py-triangle = "*"
cmocean = "*"
cartopy = "*"

[feature.devtools.dependencies]
pdbpp = "*"
line_profiler = "*"
memory_profiler = "*"
snakeviz = "*"
icecream = "*"
ipykernel = "*"
snoop = "*"
pyinstrument = "*"

[feature.devtools.target.linux-64.dependencies]
memray = "*"

[feature.devtools.target.osx-64.dependencies]
memray = "*"

[feature.devtools.target.osx-arm64.dependencies]
memray = "*"

[feature.devtools.pypi-dependencies]
tuna = ">=0.5.11"

[feature.docs.dependencies]
parcels = { path = "." }
numpydoc = "*"
myst-nb = "*"
ipython = "*"
sphinx = ">=9.0.0"
pandoc = "*"
pydata-sphinx-theme = "*"
sphinx-autobuild = "*"
sphinxcontrib-mermaid = "*"
sphinx-design = "*"
sphinx-autoapi = "*"
sphinx-notfound-page = "*"
vale = "*"

[feature.docs.tasks]
docs-only-clean = { cmd = "make clean", cwd = "docs", description = "Cleans the documentation folder of build artifacts." }
docs = { cmd = "make html", cwd = "docs", description = "Build the documentation." }
docs-clean = { depends-on = [
  { task = "docs-only-clean" },
  { task = "docs" },
], description = "Build the documentation from a clean docs folder." }
docs-watch = { cmd = "make livehtml", cwd = "docs", description = "Build and auto-rebuild the documentation on changes.", depends-on = [
  "docs-only-clean",
] }
docs-run-notebook = { cmd = "rm -rf tmp-docs-run-notebook && mkdir tmp-docs-run-notebook && mystnb-to-jupyter --overwrite {{ file }} tmp-docs-run-notebook/notebook.ipynb && cd tmp-docs-run-notebook && jupyter execute --inplace notebook.ipynb && cd .. && echo 'Notebook passed! See the rendered output in the `tmp-docs-run-notebook/notebook.ipynb`.'", args = [
  "file",
], description = "Execute a single MyST notebook (.md) or Jupyter notebook (.ipynb) outside of the docs build." }
docs-linkcheck = { cmd = "make linkcheck", cwd = "docs", description = "Verify all links in documentation don't 404." }
docs-spelling = { cmd = "python tools/lint_british_english.py docs/user_guide/examples/tutorial*.ipynb docs/user_guide/examples/tutorial*.md docs/user_guide/getting_started/tutorial*.ipynb docs/user_guide/getting_started/tutorial*.md", description = "Check tutorial prose uses British English." }
more-qaqc = { depends-on = [
  "docs-spelling",
], description = "Additional QAQC tooling separate to pre-commit hooks" }

[feature.pre-commit.dependencies]
pre_commit = "*"

[feature.pre-commit.tasks]
lint = { cmd = "pre-commit run --all-files", description = "Run all pre-commit linting hooks." }

[feature.numpydoc.dependencies]
numpydoc = "*"

[feature.numpydoc.tasks]
numpydoc-lint = { cmd = "python tools/numpydoc-public-api.py", description = "Lint public API docstrings with numpydoc." }

[feature.typing.dependencies]
mypy = "*"
lxml = "*" # in CI
types-tqdm = "*"
pandas-stubs = "*"
pyarrow-stubs = "*"

[feature.typing.tasks]
typing = { cmd = "mypy", description = "Run static type checking with mypy." }


[environments]
default = { features = [
  "test",
  "notebooks",
  "typing",
  "pre-commit",
  "numpydoc",
  "devtools",
], solve-group = "main" }
test = { features = [
  "test",
], solve-group = "main" } # resolves to the latest Python
test-min-versions = { features = ["test", "min-versions"] }
test-py311 = { features = ["test", "py311"] }
test-py313 = { features = ["test", "py313"] }
test-notebooks = { features = ["test", "notebooks"], solve-group = "main" }
docs = { features = ["docs", "notebooks"], solve-group = "docs" }
typing = { features = ["typing"], solve-group = "main" }

[pypi-dependencies]
detect-test-pollution = ">=1.2.0, <2"