Skip to content

Commit

Permalink
docs: add model providers section to contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
tsutterley committed Sep 5, 2024
1 parent 40a9bb4 commit 7420ce2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
9 changes: 7 additions & 2 deletions doc/source/getting_started/Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Ways to Contribute
3) Improving documentation and testing
4) Sharing use cases and examples (such as `Jupyter Notebooks <../user_guide/Examples.html>`_)
5) Providing code for everyone to use
6) Adding model providers to the database

Requesting a Feature
--------------------
Expand Down Expand Up @@ -61,15 +62,19 @@ Adding Examples
Examples may be in the form of executable scripts or interactive `Jupyter Notebooks <../user_guide/Examples.html>`_.
Fully working (but unrendered) examples should be submitted with the same steps as above.

Adding Model Providers
^^^^^^^^^^^^^^^^^^^^^^
Model providers can be added to their respective `JSON files <https://github.com/tsutterley/pyTMD/tree/main/providers>`_.
The main database can then be updated by running the `merge providers <https://github.com/tsutterley/pyTMD/blob/main/providers/_providers_to_database.py>`_ script.

Continuous Integration
^^^^^^^^^^^^^^^^^^^^^^
We use `GitHub Actions <https://github.com/tsutterley/pyTMD/actions>`_ continuous integration (CI) services to build and test the project on Linux (Ubuntu) and Mac Operating Systems.
The configuration files for this service are in `.github/workflows <https://github.com/tsutterley/pyTMD/blob/main/.github/workflows>`_.
The configuration files for this service are in the `GitHub workflows <https://github.com/tsutterley/pyTMD/tree/main/.github/workflows>`_ directory.
The workflows rely on the `environment.yml <https://github.com/tsutterley/pyTMD/blob/main/environment.yml>`_ and `requirements-dev.txt <https://github.com/tsutterley/pyTMD/blob/main/requirements-dev.txt>`_ files to install the required dependencies.

The GitHub Actions jobs include:

* Updating `leap second <https://github.com/tsutterley/pyTMD/blob/main/pyTMD/data/leap-seconds.list>`_ and `delta time <https://github.com/tsutterley/pyTMD/blob/main/pyTMD/data/merged_deltat.list>`_ files
* Running `flake8 <https://flake8.pycqa.org/en/latest/>`_ to check the code for style and compilation errors
* Running the test suite on multiple combinations of OS and Python version
* Uploading test coverage statistics to `Codecov <https://app.codecov.io/gh/tsutterley/pyTMD>`_
Expand Down
5 changes: 4 additions & 1 deletion providers/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
pyTMD Providers
===============

The main database is created by merging the model provider JSON files

- ``AVISO``: `AVISO Global Ocean Tide Models <https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_
- ``ESR``: `Earth and Space Research Polar Tide Models <https://www.esr.org/research/polar-tide-models/>``
- ``ESR``: `Earth and Space Research Polar Tide Models <https://www.esr.org/research/polar-tide-models/>`_
- ``GSFC``: `NASA Goddard Space Flight Center Global Tide Models <https://earth.gsfc.nasa.gov/geo/data/ocean-tide-models>`_
- ``TPXO``: `Oregon State University TPXO Tide Models <https://www.tpxo.net/home>`_
- ``providers``: Additional or stand-alone model providers

0 comments on commit 7420ce2

Please sign in to comment.