WARNING: This package is still under heavy development, and may lack some necessary features or even fail to run correctly. It is NOT recommended to use it at the moment!

This fg21sim package provides the tools to simulate the realistic low-frequency radio foregrounds, which can be further used to test various foreground removal or separation methods, for the purpose of successfully detecting the 21cm cosmological signal arising from the neutral hydrogen (HI) at epoch of reionization (EoR).

• 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) (Note: need update to simulate within sky patches)

  • extragalactic/clusters: Emission from extragalactic galaxy clusters (Note: only radio halos considered at the moment)

  • extragalactic/pointsources: Emission from multiple types of extragalactic discrete point sources (WARNING: need significant updates and integration!)

    Current supported point sources types:

    • Star-forming galaxies
    • Star-bursting galaxies
    • Radio-quiet AGNs
    • Fanaroff-Riley type I (FR-I) AGNs
    • Fanaroff-Riley type II (FR-II) AGNs

• All-sky simulation by utilizing HEALPix (Note: only support some of the components)

• High-resolution simulation within sky patches (Note: assume a flat sky for the moment)

• Configuration file allowing fine-grained control

• Modular and well-designed API

• Easy-to-use command line tools (CLI)

• Simple Web UI (WARNING: need significant updates against recent changes!)

• Other handy utilities

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

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
   

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

4. Install this fg21sim package to the virtual environment:

   $ python3 setup.py install
   

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

   $ fg21sim --help
   $ fg21sim-webui --help
   

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 package running with DEBUG logging level.

To get started, read the User Guide.

WARNING: The documentation is out-of-date with the current code, and needs significant updates!

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

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

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.