Installation

pip install kspace

Developing kspace

kspace uses uv for dependency management.

uv sync

This installs the core dependencies (numpy, scipy, numba). The example notebooks under examples/ need a few heavier, optional dependencies (matplotlib, pandas, yt, h5py, pooch) to run — install those with:

uv sync --group docs

The same dependency group also includes everything needed to build this documentation site (see Conventions for the underlying assumptions kspace makes about grids and Fourier conventions before diving into the API).

Building the documentation locally

uv run --group docs sphinx-build -b html docs docs/_build/html

Then open docs/_build/html/index.html in a browser.