Create documentation for new PyNEMO features

NOC-MSM / pyBDY

pyBDY: a Python based regional NEMO model configuration toolbox.

GNU General Public License v3.0

7 stars 7 forks source link

Create documentation for new PyNEMO features #57

Closed thopri closed 4 years ago

thopri commented 4 years ago

CMEMS repository access and Tidal Models TPXO and FES have been implemented into PyNEMO. Documentation does not yet exist showing how to use these new features. This needs writing, things to write:

installation of PyNEMO, this exists but needs to checked/updated
how to use Tides, both TPXO and FES
how to use CMEMS as a data source
how to run pytest (part of installation process)
worked example (benchmark?)

thopri commented 4 years ago

Written new and updated old pages. Just need to add two examples, one using CMEMS and one using FES tide.

thopri commented 4 years ago

Also need to add how to use tidal checker.

thopri commented 4 years ago

Completed documentation writeup.