Merge branch 'main' into drop_py38

.github/workflows/draft-pdf.yml

@@ -0,0 +1,23 @@
+on: [push, workflow_dispatch]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v1
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper/paper.pdf

.github/workflows/mkdocs-deploy.yml

@@ -8,14 +8,14 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
       - name: Install and configure Poetry
-        uses: snok/[email protected].3
+        uses: snok/[email protected].4
         with:
           version: 1.2.2
           virtualenvs-in-project: true

.github/workflows/tests.yml

@@ -11,14 +11,14 @@ jobs:
         os: [ubuntu-latest]
         python-versions: ['3.9', '3.10', '3.11', '3.12']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install and configure Poetry
-        uses: snok/[email protected].3
+        uses: snok/[email protected].4
         with:
           version: 1.2.2
           virtualenvs-in-project: true
@@ -48,7 +48,7 @@ jobs:
           pytest tests -v --cov=./zodipy --cov-report=xml:./coverage.xml --cov-report term-missing
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           files: coverage.xml
           fail_ci_if_error: false

.gitignore

@@ -172,3 +172,5 @@ settings.json
 #files
 test.py
 context.py
+
+*.pdf

README.md

@@ -13,7 +13,7 @@
 ---
 
 
-ZodiPy is an [Astropy affiliated](https://www.astropy.org/affiliated/) package, which simulates the zodiacal light in intensity that an arbitrary solar system observer is predicted to see given an interplanetary dust model and a scanning strategy, either in the form of timestreams or HEALPix maps.
+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)
 
@@ -29,6 +29,7 @@ ZodiPy supports all Python versions >= 3.9, and has the following dependencies:
 - [NumPy](https://numpy.org/)
 - [healpy](https://healpy.readthedocs.io/en/latest/)
 - [jplephem](https://pypi.org/project/jplephem/)
+- [SciPy](https://scipy.org/)
 
 
 # A simple example
@@ -64,7 +65,7 @@ See [CITATION](https://github.com/Cosmoglobe/zodipy/blob/dev/CITATION.bib) if yo
 Contributing developers will need to download the following additional dependencies:
 - pytest
 - pytest-cov
-- hypothesis (<=6.47.5)
+- hypothesis
 - coverage
 - ruff
 - mypy

docs/index.md

@@ -8,7 +8,7 @@
 [![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)
 
-ZodiPy is an [Astropy affiliated](https://www.astropy.org/affiliated/) package, which simulates the zodiacal light in intensity that an arbitrary solar system observer is predicted to see given an interplanetary dust model and a scanning strategy, either in the form of timestreams or HEALPix maps.
+ZodiPy is an [Astropy affiliated](https://www.astropy.org/affiliated/) package for simulating zodiacal light in intensity for arbitrary Solar system observers.
 ![ZodiPy Logo](img/zodipy_map.png)
 
 

docs/install.md

@@ -12,7 +12,8 @@ pip install zodipy
 ## Dependencies
 ZodiPy has the following dependencies (these are automatically downloaded alongside ZodiPy):
 
-- [numpy](https://numpy.org)
-- [astropy](https://www.astropy.org) (>= 5.0.1)
+- [Astropy](https://www.astropy.org) (>= 5.0.1)
+- [NumPy](https://numpy.org)
 - [healpy](https://healpy.readthedocs.io/en/latest/)
 - [jplehem](https://pypi.org/project/jplephem/)
+- [SciPy](https://scipy.org/)