v2.0 of zeus21!

.github/workflows/python-tests.yml

@@ -42,13 +42,7 @@ jobs:
     - name: Install package
       run: |
         pip install -e .
-
-    - name: Debug SFR_III function
-      env:
-        CLASSDIR: ${{ github.workspace }}/class_public
-      run: |
-        python -c "import zeus21; from zeus21.sfrd import SFR_III; import inspect; print('SFR_III parameters:', inspect.signature(SFR_III)); print('Parameter count:', len(inspect.signature(SFR_III).parameters))"
-
+
     - name: Run tests with coverage
       env:
         CLASSDIR: ${{ github.workspace }}/class_public
@@ -64,4 +58,4 @@ jobs:
         flags: unittests
         name: codecov-umbrella
         verbose: true
-        fail_ci_if_error: false
+        fail_ci_if_error: false

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - requirements: requirements.txt
+    - method: pip
+      path: .

AUTHORS.rst

@@ -0,0 +1,11 @@
+=======
+Authors
+=======
+
+* Julian B. Muñoz - `github.com/JulianBMunoz <https://github.com/JulianBMunoz>`_
+* Hector Afonso G. Cruz `github.com/hcruz1998 <https://github.com/hcruz1998>`_
+* Yonny Sklansky - `github.com/yonboyage <https://github.com/yonboyage>`_
+* Emilie Thélie - `github.com/EmilieThelie <https://github.com/EmilieThelie>`_
+* Sarah Libanore - `github.com/slibanore <https://github.com/slibanore>`_
+* Emily Bregou - `github.com/ebregou <https://github.com/ebregou>`_
+* Alessandra Venditti - `github.com/alessandra-venditti <https://github.com/alessandra-venditti>`_

README.md

@@ -1,8 +1,9 @@
 <p align="center">
-<img src="docs/Zeus21Logo-Horizontal.jpg" width=75% height=75%>
+<img src="docs/images/Zeus21Logo-Horizontal.jpg" width=75% height=75%>
 </p>
 
-# Zeus21: Lightning-fast simulations of cosmic dawn
+
+# Zeus21: Lightning-fast simulations of cosmic dawn and reionization
 
 [![Tests](https://github.com/JulianBMunoz/Zeus21/actions/workflows/python-tests.yml/badge.svg)](https://github.com/JulianBMunoz/Zeus21/actions/workflows/python-tests.yml)
 [![codecov](https://codecov.io/gh/JulianBMunoz/Zeus21/branch/main/graph/badge.svg)](https://codecov.io/gh/JulianBMunoz/Zeus21)
@@ -11,57 +12,5 @@ Zeus21 encodes the effective model for the 21-cm power spectrum and global signa
 
 Zeus21 (Zippy Early-Universe Solver for 21-cm) pairs well with data from [HERA](https://reionization.org/), but can be used for any 21-cm inference or prediction. Current capabilities include finding the 21-cm power spectrum (at a broad range of k and z), the global signal, IGM temperatures (Tk, Ts, Tcolor), neutral fraction xHI, Lyman-alpha fluxes, and the evolution of the SFRD; all across cosmic dawn z=5-35. Zeus21 can use three different astrophysical models, one of which emulates 21cmFAST, and can vary the cosmology through CLASS. 
 
-If you want to get started I recommend checking the Jupyter tutorials in `docs/`. Full documentation in [ReadTheDocs](https://zeus21.readthedocs.io/en/latest/), more coming soon. Here is an example power spectrum (at k=0.3/Mpc) and global signal as a function of redshift, for two cases of X-ray luminosity. You can run it yourself with the tutorial included!
-
-<p align="center">
-<img src="docs/PspecandGlobal_Zeus21.png" width=50% height=50%>
-</p>
-
-Currently you can find tutorials for:
-
-<ul>
-  <li>Basics, running and plotting 21-cm power spectra and global signals. </li>
-  <li>UVLFs, comparing to HST and JWST predictions at high redshifts. </li>
-  <li>PopIII stars, and how they affect the cosmic-dawn 21-cm signal. </li>
-</ul>
-
-## Installation
-
-You can download and install this package by doing:
-
-```
-git clone https://github.com/julianbmunoz/zeus21.git zeus21
-cd zeus21/
-pip install .
-```
-
-that should take care of all dependencies (remember to work in your favorite conda env). If you have issues with cache'd versions of packages you can add `--no-cache-dir` at the end of `pip install .`. 
-
-**NOTE:** You may run into problems when pip-installing `classy` (the Python wrapper of `CLASS`). If so, their installation guide is [here](https://github.com/lesgourg/class_public/wiki/Installation), but in short the steps are:
-
-```
-git clone https://github.com/lesgourg/class_public.git class
-cd class/
-make
-cd python/
-python setup.py install --user
-```
-
-(modifying the Makefile to your `gcc` as needed)
-
-## Citation
-
-If you find this code useful please cite:
-
-[An Effective Model for the Cosmic-Dawn 21-cm Signal](https://arxiv.org/abs/2302.08506)
-
-and include a link to [this Github](https://github.com/JulianBMunoz/Zeus21).
-
-If you use the UVLF module please cite:
-
-[Breaking degeneracies in the first galaxies with clustering](https://arxiv.org/abs/2306.09403)
-
-And if you use relative velocites, Lyman-Werner feedback, or Population III stars please cite:
-
-[The First Billion Years in Seconds: An Effective Model for the 21-cm Signal with Population III Stars](https://arxiv.org/abs/2407.18294).
+Full **documentation** (with [installation instructions](https://zeus21.readthedocs.io/en/latest/installation.html), [tutorials](https://zeus21.readthedocs.io/en/latest/tutorials.html), and [full api description](https://zeus21.readthedocs.io/en/latest/api/modules.html)) can be found on [ReadTheDocs](https://zeus21.readthedocs.io/en/latest/).