Skip to content

Latest commit

 

History

History
299 lines (232 loc) · 9.39 KB

README.rst

File metadata and controls

299 lines (232 loc) · 9.39 KB
Raw

globalemu: Robust and Fast Global 21-cm Signal Emulation

Introduction

globalemu:Robust Global 21-cm Signal Emulation
Author:Harry Thomas Jones Bevins
Version:1.8.2
Homepage:https://github.com/htjb/globalemu
Documentation:https://globalemu.readthedocs.io/
Documentation Status https://codecov.io/gh/htjb/globalemu/branch/master/graph/badge.svg?token=4KLLNT45TQ github CI MIT License ascl:2104.028

Installation

The software can be pip installed from the PYPI repository via,

pip install globalemu

or alternatively it can be installed from the git repository via.

git clone https://github.com/htjb/globalemu.git # or the equivalent using ssh keys
cd globalemu
python setup.py install --user

Emulating the Global 21-cm Signal

globalemu is a fast and robust approach for emulating the Global or sky averaged 21-cm signal and the associated neutral fraction history. In the cited MNRAS paper below we show that it is a factor of approximately 102 times faster and 2 times as accurate as the previous state of the art 21cmGEM. The code is also flexible enough for it to be retrained on detailed simulations containing the most up to date physics. We release two trained networks, one for the Global signal and one for the neutral fraction history, details of which can be found in the MNRAS paper below.

You can download trained networks with the following code after pip installing or installing via the github repository:

from globalemu.downloads import download

download().model() # Redshift-Temperature Network
download(xHI=True).model() # Redshift-Neutral Fraction Network

which will produce two files in your working directory 'T_release/' and 'xHI_release/'. Each file has the respective network model in and related pre and post processing files. You can then go on to evaluate each network for a set of parameters by running:

from globalemu.eval import evaluate

# [fstar, vc, fx, tau, alpha, nu_min, R_mfp]
params = [1e-3, 46.5, 1e-2, 0.0775, 1.25, 1.5, 30]

predictor = evaluate(base_dir='T_release/') # Redshift-Temperature Network
signal, z = predictor(params)

# note the parameter order is different for the neutral fraction emulator
# [fstar, vc, fx, nu_min, tau, alpha, R_mfp]
params = [1e-3, 46.5, 1e-2, 1.5, 0.0775, 1.25, 30]

predictor = evaluate(base_dir='xHI_release/') # Redshift-Neutral Fraction Network
signal, z = predictor(params)

The code can also be used to train a network on your own Global 21-cm signal or neutral fraction simulations using the built in globalemu pre-processing techniques. There is some flexibility on the required astrophysical input parameters and the pre-processing steps which is detailed in the documentation. More details about training your own network can be found in the documentation.

globalemu GUI

globalemu also features a GUI that can be invoked from the command line and used to explore how the structure of the Global 21-cm signal varies with the values of the astrophysical inputs. The GUI needs a configuration file to run and this can be generated using a built in globalemu function. GUI configuration files can be generated for any trained model. For example, if we wanted to generate a configuration file for the released Global signal emulator we would run,

from globalemu.gui_config import config

paramnames = [r'$\log(f_*)$', r'$\log(V_c)$', r'$\log(f_X)$',
              r'$\tau$', r'$\alpha$', r'$\nu_\mathrm{min}$',
              r'$R_\mathrm{mfp}$']

config('T_release/', paramnames, 'data/')

where the directory 'data/' contains the training and testing data (in this case that corresponding to 21cmGEM).

The GUI can then be invoked from the terminal via,

globalemu /path/to/base_dir/T_release/etc/

An image of the GUI is shown below.

graphical user interface

The GUI can also be used to investigate the physics of the neutral fraction history by generating a configuration file for the released trained model. There is no need to specify that the configuration file is for a neutral fraction emulator.

Configuration files for the released models are provided.

Documentation

The documentation is available at: https://globalemu.readthedocs.io/

It can be compiled locally after downloading the repo and installing the relevant packages (see below) via,

cd docs
sphinx-build source html-build

You can find a tutorial notebook here.

T_release/ and xHI_release/

The currently released global signal trained model, T_release/ is trained on the same training data set as 21cmGEM which is available here. The data used to train the neutral fraction history network, xHI_release/ is not publicly available but comes from the same large scale simulations used to model the global signal.

For both models the input parameters and ranges are given below.

Parameter Description T_release/ xHI_release/ Min Max
    Input Order Input Order    
f* Star Formation Efficiency 1 1 0.0001 0.5
Vc Minimal Virial Circular Veloity 2 2 4.2 km/s 100 km/s
fx X-ray Efficiency 3 3 0 1000
tau CMB Optical Depth 4 5 0.04 0.17
alpha Power of X-ray SED slope 5 6 1.0 1.5
nu min Low Energy Cut Off of X-ray SED 6 4 0.1 keV 3 keV
Rmfp Mean Free Path of Ionizing Photons 7 7 10.0 Mpc 50.0 Mpc

Licence and Citation

The software is free to use on the MIT open source license. If you use the software for academic puposes then we request that you cite the globalemu paper below.

MNRAS pre-print (referred to in the documentation as the globalemu paper),

Bevins, H., W. J. Handley, A. Fialkov, E. D. L. Acedo and K. Javid. “GLOBALEMU: A novel and robust approach for emulating the sky-averaged 21-cm signal from the cosmic dawn and epoch of reionisation.” (2021). arXiv:2104.04336

Below is the bibtex,

@article{Bevins2021,
      author = {{Bevins}, H.~T.~J. and {Handley}, W.~J. and {Fialkov}, A. and {de Lera Acedo}, E. and {Javid}, K.},
        title = "{GLOBALEMU: a novel and robust approach for emulating the sky-averaged 21-cm signal from the cosmic dawn and epoch of reionization}",
      journal = {\mnras},
        year = 2021,
        month = dec,
      volume = {508},
      number = {2},
        pages = {2923-2936},
          doi = {10.1093/mnras/stab2737},
archivePrefix = {arXiv},
      eprint = {2104.04336},
primaryClass = {astro-ph.CO},
      adsurl = {https://ui.adsabs.harvard.edu/abs/2021MNRAS.508.2923B},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Requirements

To run the code you will need to following additional packages:

When installing via pip or from source via setup.py the above packages will be installed if absent.

To compile the documentation locally you will need:

To run the test suit you will need:

Contributing

Contributions to globalemu are very much welcome and can be made via,

  • Opening an issue to report a bug/propose a new feature.
  • Making a pull request. Please consider opening an issue first to discuss any proposals and ensure the PR will be accepted.