21cmCAST

This lightweight package provides tools to perform automated analysis of 21cmFAST¹² outputs and in particular run Fisher foreCASTs. It has initially been built on / complementarily to the 21cmFish package³.

⚠️ If you are using this code, please cite the following work for which it has been developped

Gaétan Facchinetti, Laura Lopez-Honorez, Yuxiang Qin, Andrei Mesinger, 21cm signal sensitivity to dark matter decay [JCAP 01 (2024) 005] [arXiv:2308.16656]

Installation

In order to install the code you can install it with pip, running

pip install py21cmcast

To install a modified version of the code (or the latest version, available on github) clone this repository and run

pip install -e .

in the main folder. In addition, meta.yaml and build.sh files are provided for a manual installation with conda. However, the conda install is not garanteed to succeed since it has not been tested.

Although the installation should proceed and you should be able to import the package into your python environement, in order to analyse 21cmFAST raw data, the codes requires to have a working installation of 21cmFAST. For Fisher forcasts, you will need to install 21cmSense⁴ in order to evaluate the sensitivity of instruments (current version works with 21cmSense version 2.0.0).

Quick start guide

Examples on how to run the code are available here along with an minimal example of input config file.

Ongoing work

To do list:

• rearrange the code in a self-contained package
• uniformely use astropy units throughout the entire code
• add docstrings to the classes