s(t) emulation of smooth functions by stacking
Project description
- stemu:
s(t) emulation of smooth functions by stacking
- Version:
- 0.0.1
- Homepage:
- Documentation:
A repository for emulation of smooth functions by stacking
UNDER CONSTRUCTION
Features
Installation
stemu can be installed via pip
pip install stemu
via conda
conda install -c handley-lab stemu
or via the github repository
git clone https://github.com/handley-lab/stemu
cd stemu
python -m pip install .
You can check that things are working by running the test suite:
python -m pytest
black .
isort --profile black .
pydocstyle --convention=numpy stemu
Dependencies
Basic requirements:
Python 3.6+
Documentation:
Tests:
Documentation
Full Documentation is hosted at ReadTheDocs. To build your own local copy of the documentation you’ll need to install sphinx. You can then run:
python -m pip install ".[all,docs]"
cd docs
make html
and view the documentation by opening docs/build/html/index.html in a browser. To regenerate the automatic RST files run:
sphinx-apidoc -fM -t docs/templates/ -o docs/source/ stemu/
Citation
If you use stemu to generate results for a publication, please cite as:
H.T.J. Bevins, W.J. Handley, A. Fialkov, E. de Lera Acedo, K. Javid. globalemu: a novel and robust approach for emulating the sky-averaged 21-cm signal from the cosmic dawn and epoch of reionization, DOI: 10.1093/mnras/stab2737, Mon.Not.Roy.Astron.Soc. 508 (2021) 2, 2923-2936
or using the BibTeX:
@article{Bevins:2021eah,
author = "Bevins, H. T. J. and Handley, W. J. and Fialkov, A. and Acedo, E. de Lera 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}",
eprint = "2104.04336",
archivePrefix = "arXiv",
primaryClass = "astro-ph.CO",
doi = "10.1093/mnras/stab2737",
journal = "Mon. Not. Roy. Astron. Soc.",
volume = "508",
number = "2",
pages = "2923--2936",
year = "2021"
}
Contributing
There are many ways you can contribute via the GitHub repository.
You can open an issue to report bugs or to propose new features.
Pull requests are very welcome. Note that if you are going to propose major changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.
Adding models and data to the grid. Contact Will Handley to request models or ask for your own to be uploaded.
Questions/Comments
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.