Release 24.08.29 (#17)

* Update testing documentation.

* Update requirements.

* Update version number.

CONTRIBUTING.md

@@ -15,6 +15,22 @@ You can find the documentation source in the [docs](https://github.com/FormingWo
 If you are adding new pages, make sure to update the listing in the [`mkdocs.yml`](https://github.com/FormingWorlds/MORS/blob/main/mkdocs.yml) under the `nav` entry.
 
 The documentation is hosted on [readthedocs](https://fwl-mors.readthedocs.io).
+### Running tests
+
+MORS uses [pytest](https://docs.pytest.org/en/latest/) to run the tests. You can run the tests for yourself using:
+
+```console
+pytest
+```
+
+To check coverage:
+
+```console
+coverage run -m pytest
+coverage report  # to output to terminal
+coverage html    # to generate html report
+```
+
 
 ### Making a release
 
@@ -23,14 +39,14 @@ The versioning scheme we use is [CalVer](https://calver.org/).
 0. Update requirements files:
 
 ```console
-python tools/requirements_txt.py
+python tools/generate_requirements_txt.py
 pip-compile -o requirements_full.txt pyproject.toml
 ```
 
 1. Bump the version (`release`/`patch`) as needed
 
 ```console
-bump-my-version release
+bump-my-version bump release
 # 24.7.11
 ```
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fwl-mors"
-version = "24.7.11"
+version = "24.8.29"
 description = "Stellar rotation and activity evolution model"
 readme = "README.md"
 authors = [
@@ -70,7 +70,7 @@ testpaths = ["tests"]
 
 [tool.bumpversion]
 # https://callowayproject.github.io/bump-my-version/howtos/calver/
-current_version = "24.7.11"
+current_version = "24.8.29"
 parse = """(?x)                     # Verbose mode
     (?P<release>                    # The release part
         (?:[1-9][0-9])\\.           # YY.

requirements.txt

@@ -1,5 +1,7 @@
 # generated by tools/generate_requirements_txt.py
+click
 matplotlib
 numpy
 osfclient
+platformdirs
 scipy

requirements_full.txt

@@ -8,6 +8,8 @@ certifi==2024.7.4
     # via requests
 charset-normalizer==3.3.2
     # via requests
+click==8.1.7
+    # via fwl-mors (pyproject.toml)
 contourpy==1.2.1
     # via matplotlib
 cycler==0.12.1
@@ -32,6 +34,8 @@ packaging==24.1
     # via matplotlib
 pillow==10.3.0
     # via matplotlib
+platformdirs==4.2.2
+    # via fwl-mors (pyproject.toml)
 pyparsing==3.1.2
     # via matplotlib
 python-dateutil==2.9.0.post0