Docs update with Zensical

.github/workflows/docs.yaml

@@ -1,29 +1,29 @@
-name: Documentation 
+name: Documentation
 on:
   push:
     branches:
       - master
       - main
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
 jobs:
   deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v5
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.x"
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
+          python-version: "3.12"
+      - run: pip install -e '.[docs]'
+      - run: zensical build --clean
+      - uses: actions/upload-pages-artifact@v4
         with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: ~/.cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material markdown-include pymdown-extensions mkdocstrings  mkdocstrings-python
-      - run: mkdocs gh-deploy --force --clean
+          path: site
+      - uses: actions/deploy-pages@v4
+        id: deployment

.github/workflows/tests.yaml

@@ -1,4 +1,4 @@
-name: Tests for MORS
+name: MORS CI Test Suite
 
 on:
   push:
@@ -66,6 +66,6 @@ jobs:
           filename: covbadge.svg
           label: Coverage
           message: ${{ env.total }}%
-          minColorRange: 10
-          maxColorRange: 90
+          minColorRange: 40
+          maxColorRange: 100
           valColorRange: ${{ env.total }}

.gitignore

@@ -55,3 +55,6 @@ fs255_grid*
 # Debug 
 #*.png
 nogit*
+
+#zensical site
+site/

CONTRIBUTING.md

@@ -2,13 +2,13 @@
 
 ### Building the documentation
 
-The documentation is written in [markdown](https://www.markdownguide.org/basic-syntax/), and uses [mkdocs](https://www.mkdocs.org/) to generate the pages.
+The documentation is written in [markdown](https://www.markdownguide.org/basic-syntax/), and uses [Zensical](https://www.zensical.org/) to generate the pages.
 
 To build the documentation for yourself:
 
 ```console
 pip install -e .[docs]
-mkdocs serve
+zensical serve
 ```
 
 You can find the documentation source in the [docs](https://github.com/FormingWorlds/MORS/tree/main/docs) directory.

README.md

@@ -1,60 +1,35 @@
 # MODEL FOR ROTATION OF STARS (MORS)
 
-MORS is a Python package (distributed as `fwl-mors`) used in the [PROTEUS framework](https://github.com/FormingWorlds/PROTEUS) to model **stellar rotation** and **high-energy emission (X-ray, EUV, Ly-α)** evolution.  
-It implements the model of **Johnstone et al. (2021)** and provides stellar evolution quantities based on **Spada et al. (2013)** (plus optional Baraffe tracks).
+[![MORS CI Test Suite](https://github.com/FormingWorlds/MORS/actions/workflows/tests.yaml/badge.svg)](https://github.com/FormingWorlds/MORS/actions)
+![Coverage](https://gist.githubusercontent.com/lsoucasse/a25c37a328839edd00bb32d8527aec30/raw/covbadge.svg)
+[![License](https://img.shields.io/github/license/FormingWorlds/MORS?label=License)](https://github.com/FormingWorlds/MORS/blob/main/LICENSE.md)
+[![PyPI](https://img.shields.io/pypi/v/fwl-mors?label=PyPI)](https://pypi.org/project/fwl-mors/)
 
-> **Note:** This version includes the fix for the EUV1 → EUV2 conversion.
+MORS is a Python package for modelling the rotational spin-down and high-energy (X-ray, EUV, Ly-α) emission evolution of low-mass stars. It implements the model of [Johnstone, Bartel & Güdel (2021)](https://www.aanda.org/articles/aa/abs/2021/05/aa38407-20/aa38407-20.html) and is the stellar evolution model integrated into the [PROTEUS](https://proteus-framework.org/PROTEUS) framework.
+
+**Documentation:** https://proteus-framework.org/MORS/
 
 ## Install
 
 ```bash
 pip install fwl-mors
-```
-
-### Required data: stellar evolution tracks
-Download the stellar evolution tracks (stored on OSF):
-
-```bash
 mors download all
-mors env
-```
-
-By default, data follow the XDG base directory convention. You can override the data root with:
-
-```bash
-export FWL_DATA=/path/to/data
-```
-
-Or set a per-script directory:
-
-```python
-import mors
-star_evo = mors.StarEvo(starEvoDir="path/to/evolution-tracks")
 ```
 
 ## Quickstart
 
 ```python
 import mors
-import matplotlib.pyplot as plt
 
-star = mors.Star(Mstar=1.0, Prot=2.7)     # 1 Msun star, initial rotation period in days (at age ~1 Myr)
-print(star.Lx(150.0))                    # X-ray luminosity at 150 Myr
-
-plt.plot(star.AgeTrack, star.LxTrack)
-plt.xlabel(f"Age [{star.Units['Age']}]")
-plt.ylabel(f"Lx [{star.Units['Lx']}]")
-plt.show()
+star = mors.Star(Mstar=1.0, Prot=2.7)  # 1 Msun, initial rotation period at 1 Myr
+print(star.Lx(150.0))                  # X-ray luminosity at 150 Myr [erg s-1]
 ```
 
-## Documentation 
-
-You can find the complete documentation [here](https://proteus-framework.org/MORS/). 
-
 ## Citation
 
-When publishing results computed with MORS, please cite:
-- **Johnstone et al. (2021)** for the rotation/XUV evolution model
-- **Spada et al. (2013)** for the stellar evolution tracks used for stellar properties
+If you use MORS in published work, please cite:
+
+- [Johnstone, Bartel & Güdel (2021)](https://www.aanda.org/articles/aa/abs/2021/05/aa38407-20/aa38407-20.html), *A&A*, 649, A96 (rotation and XUV evolution model)
+- [Spada et al. (2013)](https://iopscience.iop.org/article/10.1088/0004-637X/776/2/87/meta), *ApJ*, 776, 87 (stellar evolution tracks)
 
-If you use the model cluster distribution/percentiles, also cite the rotation-measurement sources referenced in **Johnstone et al. (2020)** (Table 1, ~150 Myr bin).
+If you use the model cluster distribution or percentiles, also cite the rotation-measurement sources in Table 1 of Johnstone et al. (2021).