sjtuzyk / fg21sim

Foregrounds Simulation for EoR 21 cm Signal Detection 📡📡

Foreground Simulation for 21 cm Reionization Signal Detection

The FG21sim is a low-frequency radio foregrounds simulator aiming to provide the simulation of the common foregrounds impeding the 21 cm reionization signal detection. The simulated foregrounds can be used to evaluate the impacts of different foreground components on the EoR signal, and can be also used to help develop and test various foreground removal methods.

Features

• Supported foreground components:
  • galactic/synchrotron: Galactic synchrotron emission (Note: only the unpolarized part considered)
  • galactic/freefree: Galactic free-free emission
  • galactic/snr: Emission from Galactic supernovae remnants (SNRs)
  • extragalactic/clusters: Emission from extragalactic galaxy clusters (Note: only giant radio halos)
• All-sky simulation by utilizing HEALPix (Note: not all components are currently supported)
• High-resolution simulation within sky patches
• Configuration file allowing fine-grained control
• Well organized, commented, and documented
• Modular and highly extensible
• Command line tools, utilities, and resuable modules

Requirements

• Linux operating system (other UNIX-like systems not tested)
• Python
• CFITSIO
• HEALPix: only the C++ library required by healpy.
• LLVM: (required by llvmlite which is a dependency of Numba)

Installation

1. Clone this repository:

   $ git clone https://github.com/liweitianux/fg21sim
   

2. Install the above required software and libraries.

3. Install the required third-party Python packages. And it is recommended to use the virtual environment:

   $ cd fg21sim/
   $ make venv
   $ . venv/bin/activate
   

   (venv) $

   Check to make sure that this virtual environment is activated so that the python3 and pip3 are pointed to the virtual environment.

4. Install this software into the virtual environment:

   (venv) $ python3 setup.py install
   

5. You are ready to use this software. Just have a look, e.g.:

   (venv) $ fg21sim --help
   

Development

To ease the development and tests, you may want to install this package in the editable state:

$ cd fg21sim/
$ pip3 install --user -r requirements.txt
$ pip3 install --editable .

In addition, setting the environment variable DEBUG_FG21SIM forces this software running at the DEBUG logging level.

Documentations

To get started, read the User Guide.

Contributions

Great! Be sure to consult the guidelines in CONTRIBUTING.md.

Authors

• Weitian LI <[email protected]>
• Zhixian MA <[email protected]>

License

Unless otherwise declared:

• Codes developed by us are distributed under the MIT License;
• Documentations and products generated by us are distributed under the Creative Commons Attribution 3.0 License;
• Third-party codes and products used are distributed under their own licenses. See also LICENSE-3RDPARTY.