stable version

README.md

@@ -2,6 +2,7 @@
 
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/py21cmcast)](https://pypi.org/project/py21cmcast/)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Build Status](https://github.com/gaetanfacchinetti/21cmCAST/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/gaetanfacchinetti/21cmCAST/actions/workflows/CI.yml?query=branch%3Amain)
 
 
 This package provides tools to perform Fisher fore**CAST**s from 21cmFAST outputs. It has been built on / complementarily to the [21cmFish](https://21cmfish.readthedocs.io/en/latest/) package[^1]. A detailed example of how it works can be found in [**scripts/exec/fisher.ipynb**](./scripts/exec/fisher.ipynb). 
@@ -10,8 +11,28 @@ In order to work properly, the codes requires to have a working installation of
 - [**21cmFAST**](https://21cmfast.readthedocs.io/en/latest/)[^2][^3]
 - [**21cmSense**](https://21cmsense.readthedocs.io/en/latest/)[^4]
 
-If you are considering using this code for you own work, please cite
-- G. Facchinetti, L. Lopez-Honorez, A. Mesinger, Y. Qin (in prep.)
+If you are considering using this code, please cite the following work for which it has been developped
+- *G. Facchinetti, L. Lopez-Honorez, Y. Qin, A. Mesinger*, 21cm signal sensitivity to dark matter decay [[arXiv:2308.16656]](https://arxiv.org/abs/2308.16656)
+
+
+## Installation
+
+In order to install the code you can install it with pip running
+```
+pip install py21cmcast
+```
+In order to use and modify the code clone this repository and run
+```
+pip install -e .
+```
+in the main folder.
+
+## Quick start guide
+
+Examples on how to run the code are available [here](./examples/) along with an example of input config file.
+
+
+## Ongoing work
 
 To do list:
 - [x] rearrange the code in a self-contained package

examples/fisher.ipynb

@@ -109,10 +109,11 @@
     "fiducial.plot_xH_box()\n",
     "fiducial.plot_global_signal()\n",
     "\n",
-    "chi2 = fiducial.chi2_UV_luminosity_functions(plot = True)\n",
-    "\n",
     "print('The optical depth to reionization is:', fiducial.tau_ion)\n",
-    "print('The reduced chi^2 from UV luminosity data is:', chi2)"
+    "\n",
+    "# Uncomment only if you are not using minihalos, not implemented otherwise\n",
+    "#chi2 = fiducial.chi2_UV_luminosity_functions(plot = True)\n",
+    "#print('The reduced chi^2 from UV luminosity data is:', chi2)"
    ]
   },
   {
@@ -134,7 +135,7 @@
     "%%capture \n",
     "## Remove the long 21cmSense output\n",
     "\n",
-    "fiducial.observation = 'HERA'\n",
+    "fiducial.compute_sensitivity()\n",
     "fiducial.plot_power_spectrum()"
    ]
   },

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "py21cmcast"
-version = "1.0.1"
+version = "1.0.2"
 description = "Fisher forecasts with 21cm experiments"
 readme = "README.md"
 authors = [{ name = "Gaétan Facchinetti", email = "gaetanfacc@gmail.com" }]
@@ -15,6 +15,9 @@ classifiers = [
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
+    "Operating System :: Unix",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
 ]
 keywords = ["21cm", "fisher", "statistics", "cosmology"]
 dependencies = [

src/py21cmcast.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py21cmcast
-Version: 1.0.1
+Version: 1.0.2
 Summary: Fisher forecasts with 21cm experiments
 Author-email: Gaétan Facchinetti <gaetanfacc@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -683,6 +683,9 @@ Keywords: 21cm,fisher,statistics,cosmology
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -699,15 +702,38 @@ Requires-Dist: 21cmfast>=3.0.0; extra == "dev"
 # 21cmCAST
 
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/py21cmcast)](https://pypi.org/project/py21cmcast/)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Build Status](https://github.com/gaetanfacchinetti/21cmCAST/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/gaetanfacchinetti/21cmCAST/actions/workflows/CI.yml?query=branch%3Amain)
+
 
 This package provides tools to perform Fisher fore**CAST**s from 21cmFAST outputs. It has been built on / complementarily to the [21cmFish](https://21cmfish.readthedocs.io/en/latest/) package[^1]. A detailed example of how it works can be found in [**scripts/exec/fisher.ipynb**](./scripts/exec/fisher.ipynb). 
 
 In order to work properly, the codes requires to have a working installation of
 - [**21cmFAST**](https://21cmfast.readthedocs.io/en/latest/)[^2][^3]
 - [**21cmSense**](https://21cmsense.readthedocs.io/en/latest/)[^4]
 
-If you are considering using this code for you own work, please cite
-- G. Facchinetti, L. Lopez-Honorez, A. Mesinger, Y. Qin (in prep.)
+If you are considering using this code, please cite the following work for which it has been developped
+- *G. Facchinetti, L. Lopez-Honorez, Y. Qin, A. Mesinger*, 21cm signal sensitivity to dark matter decay [[arXiv:2308.16656]](https://arxiv.org/abs/2308.16656)
+
+
+## Installation
+
+In order to install the code you can install it with pip running
+```
+pip install py21cmcast
+```
+In order to use and modify the code clone this repository and run
+```
+pip install -e .
+```
+in the main folder.
+
+## Quick start guide
+
+Examples on 
+
+
+## Ongoing work
 
 To do list:
 - [x] rearrange the code in a self-contained package