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 (2025)

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 (2025).

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)

Quick start

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

from echo21 import echopipeline

pipe = echopipeline.pipeline()
pipe.glob_sig()

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 consider citing Mittal et al (2025).

Contact

In case of any confusion or suggestions for improvement please do not hesitate to contact me.

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-3.0.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-3.0.0-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: echo21-3.0.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-3.0.0.tar.gz
Algorithm Hash digest
SHA256 d870ce9b8188d473c6de7e3edc22a791568d40b0a8ee1aafb909e3af07e7912c
MD5 babf89115ad3f024b5d0c4f1b5f4ffe5
BLAKE2b-256 91f89fb575a9d4abec3be07a24648031a46f3eb71440a243d1315d4aa0bf8d56

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for echo21-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7584f473931701e5a73e17821463f6541476ab38a0a024d6eefa285a7e515dc3
MD5 b6b188686e8aa1a469ff24fc895e4ed1
BLAKE2b-256 cde90e580f6c93f307d7c364102a584b29bf8b65cc012906f7f0900742b7a734

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