21cmSense v2

21cmSense v2: A modular, open-source 21 cm sensitivity calculator - Published in JOSS (2024)

https://github.com/rasg-affiliates/21cmsense

Keywords from Contributors

Scientific Fields

Repository

Code for calculating the sensitivity of 21cm experiments to the EoR power spectrum

README.rst

=========
21cmSense
=========

.. image:: https://img.shields.io/pypi/v/21cmSense
   :alt: PyPI - Version
   :target: https://pypi.org/project/21cmSense
.. image:: https://codecov.io/gh/rasg-affiliates/21cmSense/branch/main/graph/badge.svg
  :target: https://codecov.io/gh/rasg-affiliates/21cmSense
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :target: https://github.com/psf/black
.. image:: https://readthedocs.org/projects/21cmsense/badge/?version=latest
  :target: https://21cmsense.readthedocs.io/en/latest/?badge=latest
  :alt: Documentation Status
.. image:: https://img.shields.io/github/license/Ileriayo/markdown-badges?style=flat
  :target: ./LICENSE.rst
.. image:: https://joss.theoj.org/papers/10.21105/joss.06501/status.svg
   :target: https://doi.org/10.21105/joss.06501

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 

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 

and then::

    $ sense calc-sense  --array-file=

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.

Owner

JOSS Publication

21cmSense v2: A modular, open-source 21 cm sensitivity calculator

Published

May 09, 2024

DOI

10.21105/joss.06501

Volume 9, Issue 97, Page 6501

Authors

Steven G. Murray
Scuola Normale Superiore, Italy

Jonathan Pober
Department of Physics, Brown University, Providence, RI, USA

Matthew Kolopanis
School of Earth and Space Exploration, Arizona State University, Tempe, AZ, USA

Editor

Arfon Smith

Tags

astronomy 21 cm Cosmology

View PDF Review Thread Software Archive

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Murray
  given-names: Steven G.
  orcid: "https://orcid.org/0000-0003-3059-3823"
- family-names: Pober
  given-names: Jonathan
  orcid: "https://orcid.org/0000-0002-3492-0433"
- family-names: Kolopanis
  given-names: Matthew
  orcid: "https://orcid.org/0000-0002-2950-2974"
contact:
- family-names: Murray
  given-names: Steven G.
  orcid: "https://orcid.org/0000-0003-3059-3823"
doi: 10.5281/zenodo.11127253
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Murray
    given-names: Steven G.
    orcid: "https://orcid.org/0000-0003-3059-3823"
  - family-names: Pober
    given-names: Jonathan
    orcid: "https://orcid.org/0000-0002-3492-0433"
  - family-names: Kolopanis
    given-names: Matthew
    orcid: "https://orcid.org/0000-0002-2950-2974"
  date-published: 2024-05-09
  doi: 10.21105/joss.06501
  issn: 2475-9066
  issue: 97
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6501
  title: "21cmSense v2: A modular, open-source 21 cm sensitivity
    calculator"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06501"
  volume: 9
title: "21cmSense v2: A modular, open-source 21 cm sensitivity
  calculator"

GitHub Events

Committers

Last synced: 7 months ago

Issues and Pull Requests

Last synced: 6 months ago