Skip to content

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

License

Notifications You must be signed in to change notification settings

21cmfast/tuesday

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6dc1247 · Mar 13, 2025

History

90 Commits
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025
Jul 2, 2024
Jul 2, 2024
Jul 2, 2024
Mar 13, 2025
Mar 13, 2025
Mar 13, 2025

Repository files navigation

tuesday

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

License: MIT PyPi version PyPI pyversions Documentation Status Black Codecov

Installation

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

pip install tuesday-eor

or

uv pip install tuesday-eor

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

uv sync
source .venv/bin/activate

Documentation

Documentation at https://tuesday.readthedocs.io/en/latest/

Development

If you are developing tuesday, 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.