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?

Use this code to generate the global 21-cm signal(s) for a given set of astrophysical and cosmological parameters.

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)

  • pybaselines (recommended version 1.1.0)

  • pandas (recommended version 3.0.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.1.0.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.1.0-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: echo21-4.1.0.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.1.0.tar.gz
Algorithm Hash digest
SHA256 1d0518070a444cec2d8e3495ec4c8d1e0b199859df61649767f2147782d0e2cb
MD5 bc29a3dfc25a5d0ee0395f3322da0aea
BLAKE2b-256 cacb0eeaddec543c9bf4986d2ea9a42627472140ca2ddecce2dc1dc6f5acba44

See more details on using hashes here.

File details

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

File metadata

  • Download URL: echo21-4.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.8 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd893424899d2b0e65424a7b54e72d51f286d1e57ea3b7cca51d176e16cc8c4d
MD5 7f32f0fe05f69b44f7d1628eb6996a49
BLAKE2b-256 154152e51160d581d2a5cdecc34284eae22a94f51eba39d5f6d500eb0d64156f

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