Skip to main content

Exploring the Cosmos with Hydrogen Observation

Project description

Overview

Name:

Exploring Cosmos with Hydrogen Observation

Author:

Shikhar Mittal

Paper:

Mittal et al (2026)

Documentation:

echo21.readthedocs.io

Why do you need this code?

ECHO21 is a fast and flexible Python package for modelling the global 21-cm signal across cosmic history - from the dark ages to reionization. Given a set of astrophysical and cosmological parameters, the code self-consistently generates the global 21-cm signal, neutral hydrogen fraction, and CMB optical depth.

Designed for both precision studies and large-scale parameter inference, ECHO21 combines physical realism with computational efficiency. Its key features include:

  • simultaneous variation of astrophysical and cosmological parameters,

  • flexible prescriptions for halo mass functions and star formation models,

  • inclusion of Ly \(\alpha\) heating and detailed IGM thermal evolution,

  • support for non-standard cosmologies such as interacting dark matter (Mittal et al 2026).

A single realization of the signal can be generated in \(\sim 1\) second, making the code ideally suited for Bayesian inference, emulator training, and large parameter-space explorations.

ECHO21 is MPI-parallelized and scalable - equally at home on a laptop or a high-performance computing cluster.

Read more about it in the paper Mittal et al (2026).

Installation and requirements

This package can be installed as

pip install echo21

We recommend working on a Python version > 3.8. Packages required are

  • numpy (recommended version 2.1.3)

  • scipy (recommended version 1.14.1)

  • mpi4py (recommended version 4.0.1)

  • tqdm (recommended version 4.67.1)

  • colossus (recommended version 1.3.6)

  • pandas (recommended version 3.0.1)

  • tables (recommended version 3.11.1)

Quick start

The following code more or less captures the main functionalities of this package.

from echo21 import echopipeline

pipe = echopipeline.pipeline()
pipe.run_simulation()

Save the above code as (say) my_echo_script.py and run it as

python my_echo_script.py

Running the above will generate an output folder with the name output_<YYYYMMDD-hhmmss> which contains several files. To learn how to set the astrophysical or cosmological parameters, halo mass function, star formation model, redshifts at which to evaluate the global signal, and structure of the output files see the documentation. To learn about the physics of this package see our paper.

Once you have an understanding of the structure of output files, you can write your own scripts to create figures. To help you get started, see the jupyter notebook make_figures.ipynb in the example folder.

Documentation

For more details on the working of the package and understanding the output files refer to the documentation.

License and citation

The software is free to use on the MIT open-source license. If you use the software then please cite Mittal et al (2026).

If the code is used in a project where the author has provided significant scientific input, guidance on methodology, or assistance with interpretation of results, then co-authorship on resulting publications is expected, following standard academic practice.

Users are encouraged to contact the author when using the code for new scientific applications or major projects.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

echo21-4.2.1.tar.gz (19.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

echo21-4.2.1-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

Details for the file echo21-4.2.1.tar.gz.

File metadata

  • Download URL: echo21-4.2.1.tar.gz
  • Upload date:
  • Size: 19.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for echo21-4.2.1.tar.gz
Algorithm Hash digest
SHA256 d693c4800f37bf7735cd5e1afa298b9dfd6586925c9933bb14407dbf9340000b
MD5 0909e58221fafd4942e3d88fda16221a
BLAKE2b-256 648881bf263df6661b79f3b08dd5ac24b589cd1914e76a9cf2161cd0477a2cd3

See more details on using hashes here.

File details

Details for the file echo21-4.2.1-py3-none-any.whl.

File metadata

  • Download URL: echo21-4.2.1-py3-none-any.whl
  • Upload date:
  • Size: 27.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for echo21-4.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d00e3f3046308fc1bc5bc9c13cecdf2aca8464543a2621f510fb15bb64798ed9
MD5 d6ab7204a7df99fc987593d36888f413
BLAKE2b-256 aae85b03f9a2009fa445b6ead0a27685634b07bfaa0cfb296de864a04306b185

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page