Update README.md and CITATION.bibwith JOSS paper [no ci].

Cosmoglobe · Apr 20, 2024 · 3594196 · 3594196
1 parent b5d0031
commit 3594196
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 49 deletions.
diff --git a/CITATION.bib b/CITATION.bib
@@ -1,17 +1,30 @@
-@ARTICLE{zodipy,
-       author = {{San}, M. and {Herman}, D. and {Erikstad}, G.~B. and {Galloway}, M. and {Watts}, D.},
-        title = "{COSMOGLOBE: Simulating zodiacal emission with ZodiPy}",
-      journal = {\aap},
-     keywords = {interplanetary medium, cosmic background radiation, zodiacal dust, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
-         year = 2022,
-        month = oct,
-       volume = {666},
-          eid = {A107},
-        pages = {A107},
-          doi = {10.1051/0004-6361/202244133},
-archivePrefix = {arXiv},
-       eprint = {2205.12962},
- primaryClass = {astro-ph.EP},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2022A&A...666A.107S},
-      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+@article{San2022,
+  author        = {{San}, M. and {Herman}, D. and {Erikstad}, G.~B. and {Galloway}, M. and {Watts}, D.},
+  title         = {{COSMOGLOBE: Simulating zodiacal emission with ZodiPy}},
+  journal       = {\aap},
+  keywords      = {interplanetary medium, cosmic background radiation, zodiacal dust, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
+  year          = 2022,
+  month         = oct,
+  volume        = {666},
+  eid           = {A107},
+  pages         = {A107},
+  doi           = {10.1051/0004-6361/202244133},
+  archiveprefix = {arXiv},
+  eprint        = {2205.12962},
+  primaryclass  = {astro-ph.EP},
+  adsurl        = {https://ui.adsabs.harvard.edu/abs/2022A&A...666A.107S},
+  adsnote       = {Provided by the SAO/NASA Astrophysics Data System}
 }
+
+@article{San2024,
+  doi       = {10.21105/joss.06648},
+  url       = {https://doi.org/10.21105/joss.06648},
+  year      = {2024},
+  publisher = {The Open Journal},
+  volume    = {9},
+  number    = {96},
+  pages     = {6648},
+  author    = {Metin San},
+  title     = {ZodiPy: A Python package for zodiacal light simulations},
+  journal   = {Journal of Open Source Software}
+} 
diff --git a/README.md b/README.md
@@ -1,48 +1,37 @@
 
 <img src="docs/img/zodipy_logo.png" width="350">
 
-[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat-square)](http://www.astropy.org/)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zodipy?style=flat-square)
-[![PyPI](https://img.shields.io/pypi/v/zodipy.svg?logo=python&style=flat-square)](https://pypi.org/project/zodipy)
-[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://img.shields.io/badge/repo_status-Active-success?style=flat-square)](https://www.repostatus.org/#active)
-[![Actions Status](https://img.shields.io/github/actions/workflow/status/Cosmoglobe/Zodipy/tests.yml?branch=main&logo=github&style=flat-square)](https://github.com/Cosmoglobe/Zodipy/actions)
+[![astropy](https://img.shields.io/badge/powered%20by-AstroPy-orange.svg)](http://www.astropy.org/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zodipy)
+[![PyPI](https://img.shields.io/pypi/v/zodipy.svg?logo=python)](https://pypi.org/project/zodipy)
+[![Actions Status](https://img.shields.io/github/actions/workflow/status/Cosmoglobe/Zodipy/tests.yml?branch=main&logo=github)](https://github.com/Cosmoglobe/Zodipy/actions)
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Cosmoglobe/zodipy/mkdocs-deploy.yml?branch=main&style=flat-square&logo=github&label=docs)
-[![Codecov](https://img.shields.io/codecov/c/github/Cosmoglobe/zodipy?token=VZP9L79EUJ&style=flat-square&logo=codecov)](https://app.codecov.io/gh/Cosmoglobe/zodipy)
-[![arXiv Paper](https://img.shields.io/badge/arXiv-2205.12962-green?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2205.12962)
-[![ascl:2306.012](https://img.shields.io/badge/ascl-2306.012-blue.svg?colorB=262255&style=flat-square)](https://ascl.net/2306.012)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://img.shields.io/badge/repo_status-Active-success)](https://www.repostatus.org/#active)
+[![Codecov](https://img.shields.io/codecov/c/github/Cosmoglobe/zodipy?token=VZP9L79EUJ&logo=codecov)](https://app.codecov.io/gh/Cosmoglobe/zodipy)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/161)
+[![ascl:2306.012](https://img.shields.io/badge/ascl-2306.012-blue.svg?colorB=262255)](https://ascl.net/2306.012)
 [![DOI](https://zenodo.org/badge/394929213.svg)](https://zenodo.org/doi/10.5281/zenodo.10999611)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.06648/status.svg)](https://doi.org/10.21105/joss.06648)
 ---
 
 
 ZodiPy is an [Astropy affiliated](https://www.astropy.org/affiliated/) package for simulating zodiacal light in intensity for arbitrary Solar system observers.
 
 ![plot](docs/img/zodipy_map.png)
 
-# Help
+## Documentation
 See the [documentation](https://cosmoglobe.github.io/zodipy/) for more information and examples on how to use ZodiPy for different applications.
 
-# Installation
-ZodiPy is installed using `pip install zodipy`.
-
-# Dependencies
-ZodiPy supports all Python versions >= 3.9, and has the following dependencies:
-- [Astropy](https://www.astropy.org/) (>=5.0.1)
-- [NumPy](https://numpy.org/)
-- [healpy](https://healpy.readthedocs.io/en/latest/)
-- [jplephem](https://pypi.org/project/jplephem/)
-- [SciPy](https://scipy.org/)
-
-
-# A simple example
+## A simple example
 ```python
 import astropy.units as u
 from astropy.time import Time
 
 from zodipy import Zodipy
 
 
-model = Zodipy("dirbe")
+model = Zodipy(model="dirbe")
 
 emission = model.get_emission_ang(
     25 * u.micron,
@@ -56,14 +45,24 @@ print(emission)
 #> [15.35392831 15.35495051 15.35616009] MJy / sr
 ```
 
-# Scientific paper and citation
-For an overview of the ZodiPy model approach and other information regarding zodiacal emission and interplanetary dust modeling we refer to the scientific paper on ZodiPy:
+## Related scientific papers
+See [CITATION](https://github.com/Cosmoglobe/zodipy/blob/dev/CITATION.bib)
 - [Cosmoglobe: Simulating zodiacal emission with ZodiPy (San et al. 2022)](https://arxiv.org/abs/2205.12962). 
+- [ZodiPy: A Python package for zodiacal light simulations (San 2024)](https://joss.theoj.org/papers/10.21105/joss.06648#). 
+
 
-See [CITATION](https://github.com/Cosmoglobe/zodipy/blob/dev/CITATION.bib) if you have used ZodiPy in your work and want to cite the software.
+## Install
+ZodiPy is installed using `pip install zodipy`.
 
+## Dependencies
+ZodiPy supports all Python versions >= 3.9, and has the following dependencies:
+- [Astropy](https://www.astropy.org/) (>=5.0.1)
+- [NumPy](https://numpy.org/)
+- [healpy](https://healpy.readthedocs.io/en/latest/)
+- [jplephem](https://pypi.org/project/jplephem/)
+- [SciPy](https://scipy.org/)
 
-# For developers
+## For developers
 Contributing developers will need to download the following additional dependencies to test, lint, format and build documentation locally:
 - pytest
 - pytest-cov
@@ -82,14 +81,14 @@ Contributing developers will need to download the following additional dependenc
 
 which are required to test and build ZodiPy.
 
-## Poetry
+### Poetry
 Developers can install ZodiPy through [Poetry](https://python-poetry.org/) (Poetry >= 1.8.0) by first cloning or forking the repository, and then running 
 ```
 poetry install
 ```
 in a virtual environment from the repository root. This will read the `pyproject.toml` file in the repository and install all dependencies. 
 
-## pip
+### pip
 Developers not using Poetry can install ZodiPy in a virtual environment with all dependencies by first cloning or forking the repository and then running 
 ```
 pip install -r requirements-dev.txt
@@ -98,7 +97,7 @@ from the repositry root. This will read and download all the dependencies from t
 
 Note that developers using Python 3.12 will need to upgrade their pip versions with `python3 -m pip install --upgrade pip` before being able to install ZodiPy. This is due to known incompatibilities between older pip versions and Python 3.12
 
-## Tests, linting and formatting
+### Tests, linting and formatting
 The following tools should be run from the root of the repository with no errors. (These are ran automatically as part of the CI workflows on GitHub, but should be tested locally first)
 
 - [pytest](https://docs.pytest.org/en/8.0.x/): Tests are run with pytest by simply running `pytest` in the command line in the root of the repository. 
@@ -107,11 +106,11 @@ The following tools should be run from the root of the repository with no errors
 
 Remeber to add tests when implementing new features to maintain a high code coverage.
 
-## Documentation
+### Documentation
 We use [MkDocs](https://www.mkdocs.org/) to create our documentation. The documentation is built locally with `mkdocs build` from the repository root, and served with `mkdocs serve`.
 
 
-# Funding
+## Funding
 This work has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreements No 776282 (COMPET-4; BeyondPlanck), 772253 (ERC; bits2cosmology) and 819478 (ERC; Cosmoglobe).
 
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "zodipy"
 version = "0.9.2"
-description = "Software for simulating zodiacal emission"
+description = "A Python package for zodiacal light simulations"
 authors = ["Metin San <[email protected]>"]
 readme = "README.md"
 license = "GPL-3.0-or-later"