Skip to main content

Compute sensitivies of radio interferometers to the cosmic 21cm signal.

Project description

PyPI - Version https://codecov.io/gh/rasg-affiliates/21cmSense/branch/main/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg Documentation Status https://img.shields.io/github/license/Ileriayo/markdown-badges?style=flat https://joss.theoj.org/papers/10.21105/joss.06501/status.svg

A python package for calculating the expected sensitivities of 21cm experiments to the Epoch of Reionization and/or Cosmic Dawn power spectrum.

Installation

For Users

Clone/download the package and run pip install [-e] . in the top-level.

If you are a conda user (which we recommend), you may want to install the following using conda rather than them being automatically installed with pip:

$ conda install numpy scipy pyyaml astropy

To test that the package has installed correctly, install with pip install -e .[test] and run pytest in the top-level directory.

For Development

Clone/download the package and run pip install [-e] .[dev] in the top-level.

Run pre-commit install; pre-commit install --hook-type=commit-msg to install the pre-commit hook checks.

We recommend using the commitizen tool to write commit messages – we use the commit messages to do our versioning!

See the contributing docs for more information about how to contribute to the project!

Usage

There are two ways to use this code: as a python library or via the CLI. More documentation on using the library can found in the docs, especially in the getting started tutorial A more involved introduction to the CLI can be found in the CLI tutorial.

As a taste, the simplest possible usage is by using the CLI as follows:

$ sense calc-sense <SENSITIVITY_CONFIG_FILE.yml>

Other options to the calc-sense program can be read by using:

$ sense calc-sense --help

An example config file is in this repository under example_configs/sensitivity_hera.yml, which details the various parameters that can be set. In all, three configuration files are required – one defining an observatory, another defining an observation, and the sensitivity one already mentioned.

The CLI can also be used in a two-step process, by running:

$ sense grid-baselines <OBSERVATION_CONFIG_FILE.yml>

and then:

$ sense calc-sense <SENSITIVITY_CONFIG_FILE.yml> --array-file=<ARRAY_FILE.pkl>

where the ARRAY_FILE is produced in the first step (and its location is printed during the execution).

Running Tests

An example of how to run tests is in the Github Workflow testsuite.yaml. In short, just run pytest in the top-level directory after installing the package.

Acknowledgment

For details of the observing strategy assumed by this code, and other relevant scientific information, please see

Pober et al. 2013AJ….145…65P

and

Pober et al. 2014ApJ…782…66P

If you use this code in any of your work, please acknowledge these papers, and provide a link to this repository.

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

21cmsense-2.0.2.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

21cmSense-2.0.2-py3-none-any.whl (259.8 kB view details)

Uploaded Python 3

File details

Details for the file 21cmsense-2.0.2.tar.gz.

File metadata

  • Download URL: 21cmsense-2.0.2.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for 21cmsense-2.0.2.tar.gz
Algorithm Hash digest
SHA256 cdd7bb74a8e558d8a7643d97ba2dc07707996f1551c05ce46f470d1844a00d6b
MD5 bbd275d1ebe6ce2d9bf1f9856d90817c
BLAKE2b-256 c03e3e3180c6accb04f00bdace5258382bbcc7b117c43ae88e0e08904d369893

See more details on using hashes here.

File details

Details for the file 21cmSense-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: 21cmSense-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 259.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for 21cmSense-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b333efc6e61d1f0b0f2279e16dd9b7f0d3213e05aa8af768e6549cc6d6e83be2
MD5 98304ec20c04a53c4c46a35dab87727a
BLAKE2b-256 043d17855d40a42606c3e6883aa7543107275de63cb7f1f10c51a9e11075f04f

See more details on using hashes here.

Supported by

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