=======
21cmEMU
=======
|PyPI| |Status| |Python| |License| |RTD| |Tests| |Codecov| |pre-commit| |Black|
.. |PyPI| image:: https://img.shields.io/pypi/v/py21cmemu.svg
:target: https://pypi.org/project/py21cmemu/
.. |Status| image:: https://img.shields.io/pypi/status/py21cmemu.svg
:target: https://pypi.org/project/py21cmemu/
.. |Python| image:: https://img.shields.io/pypi/pyversions/py21cmemu.svg
.. |License| image:: https://img.shields.io/pypi/l/py21cmemu.svg
:target: https://github.com/21cmfast/21cmEMU/blob/main/LICENSE
.. |Tests| image:: https://github.com/21cmfast/21cmEMU/actions/workflows/tests.yml/badge.svg
:target: https://github.com/21cmfast/21cmEMU/actions/workflows/tests.yml
.. |Codecov| image:: https://codecov.io/gh/21cmfast/21cmEMU/branch/main/graph/badge.svg?token=yUOqyTlZ3z
:target: https://codecov.io/gh/21cmfast/21cmEMU
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
.. |RTD| image:: https://readthedocs.org/projects/21cmemu/badge/?version=latest
:target: https://21cmemu.readthedocs.io/en/latest/
:alt: Documentation Status
An emulator of 21cmFAST summaries.
Emulate the following summary statistics:
* 21-cm power spectrum
* 21-cm global brightness temperature
* IGM spin temperature
* Neutral fraction
* Thomson scattering optical depth
* UV luminosity functions
Documentation
=============
See `the documentation <https://21cmemu.readthedocs.io/en/latest/>`_ for tutorials and API.
Issues
======
If you encounter any problems, please `file an issue <https://github.com/21cmFAST/21cmEMU/issues>`_ along with a detailed description.
Contributing
============
Contributions are very welcome.
To learn more, see the `Contributor Guide <https://github.com/21cmFAST/21cmEMU/blob/main/CONTRIBUTING.md>`_.
Citation
========
If you use ``21cmEMU`` in your research, please cite `Breitman+23 <https://arxiv.org/abs/2309.05697>`_.
License
=======
Distributed under the terms of the `MIT license <https://github.com/21cmFAST/21cmEMU/blob/main/LICENSE>`_, ``21cmEMU`` is free and open source software.
Credits
-------
This project was generated from `@cjolowicz <https://github.com/cjolowicz>`_'s `Hypermodern Python Cookiecutter <https://github.com/cjolowicz/cookiecutter-hypermodern-python>`_ template.
Raw data
{
"_id": null,
"home_page": "https://github.com/21cmFAST/21cmEMU",
"name": "py21cmEMU",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": null,
"keywords": "Epoch of Reionization, Cosmology",
"author": "Daniela Breitman",
"author_email": "daniela.breitman@sns.it",
"download_url": "https://files.pythonhosted.org/packages/be/b7/2e5b67821df1aa7cee2a2cd279031aa4cfb5ad9d7ec18fac42a02dec1afd/py21cmemu-1.1.3.tar.gz",
"platform": null,
"description": "=======\n21cmEMU\n=======\n\n\n|PyPI| |Status| |Python| |License| |RTD| |Tests| |Codecov| |pre-commit| |Black|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/py21cmemu.svg\n :target: https://pypi.org/project/py21cmemu/\n.. |Status| image:: https://img.shields.io/pypi/status/py21cmemu.svg\n :target: https://pypi.org/project/py21cmemu/\n.. |Python| image:: https://img.shields.io/pypi/pyversions/py21cmemu.svg\n\n.. |License| image:: https://img.shields.io/pypi/l/py21cmemu.svg\n :target: https://github.com/21cmfast/21cmEMU/blob/main/LICENSE\n.. |Tests| image:: https://github.com/21cmfast/21cmEMU/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/21cmfast/21cmEMU/actions/workflows/tests.yml\n.. |Codecov| image:: https://codecov.io/gh/21cmfast/21cmEMU/branch/main/graph/badge.svg?token=yUOqyTlZ3z\n :target: https://codecov.io/gh/21cmfast/21cmEMU\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/ambv/black\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n.. |RTD| image:: https://readthedocs.org/projects/21cmemu/badge/?version=latest\n :target: https://21cmemu.readthedocs.io/en/latest/\n :alt: Documentation Status\n\nAn emulator of 21cmFAST summaries.\n\nEmulate the following summary statistics:\n * 21-cm power spectrum\n * 21-cm global brightness temperature\n * IGM spin temperature\n * Neutral fraction\n * Thomson scattering optical depth\n * UV luminosity functions\n\n\n\nDocumentation\n=============\n\nSee `the documentation <https://21cmemu.readthedocs.io/en/latest/>`_ for tutorials and API.\n\nIssues\n======\n\nIf you encounter any problems, please `file an issue <https://github.com/21cmFAST/21cmEMU/issues>`_ along with a detailed description.\n\nContributing\n============\n\nContributions are very welcome.\nTo learn more, see the `Contributor Guide <https://github.com/21cmFAST/21cmEMU/blob/main/CONTRIBUTING.md>`_.\n\nCitation\n========\n\nIf you use ``21cmEMU`` in your research, please cite `Breitman+23 <https://arxiv.org/abs/2309.05697>`_.\n\nLicense\n=======\nDistributed under the terms of the `MIT license <https://github.com/21cmFAST/21cmEMU/blob/main/LICENSE>`_, ``21cmEMU`` is free and open source software.\n\n\nCredits\n-------\nThis project was generated from `@cjolowicz <https://github.com/cjolowicz>`_'s `Hypermodern Python Cookiecutter <https://github.com/cjolowicz/cookiecutter-hypermodern-python>`_ template.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Emulator of 21cmFAST summaries.",
"version": "1.1.3",
"project_urls": {
"Changelog": "https://github.com/21cmFAST/21cmEMU/releases",
"Documentation": "https://21cmEMU.readthedocs.io",
"Homepage": "https://github.com/21cmFAST/21cmEMU",
"Repository": "https://github.com/21cmFAST/21cmEMU"
},
"split_keywords": [
"epoch of reionization",
" cosmology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26a762a11ba103381b2e15e5701ec18cc8287fa57890fa31c2f07f9d6d2ecf43",
"md5": "0483e4d369b556691af1954cb3a8346d",
"sha256": "1b66eae2e872c8892a93af31af7eae9acd37eb4229aa9b4e6afebad8537c1f43"
},
"downloads": -1,
"filename": "py21cmemu-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0483e4d369b556691af1954cb3a8346d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 23425,
"upload_time": "2024-04-10T15:13:05",
"upload_time_iso_8601": "2024-04-10T15:13:05.695472Z",
"url": "https://files.pythonhosted.org/packages/26/a7/62a11ba103381b2e15e5701ec18cc8287fa57890fa31c2f07f9d6d2ecf43/py21cmemu-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "beb72e5b67821df1aa7cee2a2cd279031aa4cfb5ad9d7ec18fac42a02dec1afd",
"md5": "174c089632524c2d6daa570b7f69941e",
"sha256": "4fc4b760d884e8a523dcf64b2777a9ba0f788ac071827a29a2c9a891d94f2890"
},
"downloads": -1,
"filename": "py21cmemu-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "174c089632524c2d6daa570b7f69941e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 23150,
"upload_time": "2024-04-10T15:13:07",
"upload_time_iso_8601": "2024-04-10T15:13:07.347202Z",
"url": "https://files.pythonhosted.org/packages/be/b7/2e5b67821df1aa7cee2a2cd279031aa4cfb5ad9d7ec18fac42a02dec1afd/py21cmemu-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 15:13:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "21cmFAST",
"github_project": "21cmEMU",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py21cmemu"
}
JSON
