py21cmFAST-tools

A collection of lightcone postprocessing tools such as conversion to power spectrum and plotting.

Installation

py21cmfast-tools is available on PyPI and can be installed with standard tools like pip or uv:

pip install py21cmfast-tools

or

uv pip install py21cmfast-tools

If you are developing py21cmfast-tools, we recommend using a virtual environment. You can create a new environment with uv:

uv sync
source .venv/bin/activate

Documentation

Documentation at https://py21cmfast-tools.readthedocs.io/en/latest/

Development

If you are developing py21cmfast-tools, here are some basic steps to follow to get setup.

First create a development environment with uv:

uv sync --all-extras --dev

Then install pre-commit in your repo so that style checks can be done on the fly:

pre-commit install

Make changes in a branch:

git checkout -b my-new-feature

Make sure to run the tests:

uv run pytest

If you add new dependencies, use uv to manage this:

uv add my-new-dependency

If it is a development dependency, use the --dev flag:

uv add my-new-dev-dependency --dev

When you are ready to submit your changes, open a pull request on GitHub.