search

NOAA-GFDL / pace

Re-write of FV3GFS weather/climate model in Python
Apache License 2.0
13 stars 11 forks source link

pace documentation (https://ai2cm.github.io/pace/) #67

Open xyuan opened 7 months ago

xyuan commented 7 months ago

there is markdown pace documentation https://ai2cm.github.io/pace/, but we are unable to edit, could this page be part of our github repo, so we can add more documents to it?

FlorianDeconinck commented 7 months ago

This is generated code from the docs folder. Command line is still in the makefile but might need adjustements. Docs content is pre-refactor and will also require adjustments.

Deploying to Github Pages can be automatized on PR merge and/or Release: https://github.com/actions/deploy-pages

FlorianDeconinck commented 7 months ago

The main thing is that right now the docs folder in Pace has documentation for Pace but also pyFV3, pySHiELD and NDSL

fmalatino commented 7 months ago

I think we could also add more documentation to this as well to help new users/developers get up to speed. This could include testing methods, descriptions of the functionality, etc. I think this issue can be taken on as a collaborative effort, as new features are added this will grow with them.

xyuan commented 7 months ago

we could think about the doxygen, but it requires some additional work on the source code. I am also thinking about adding some theoretical, and algorithm background on the document page too.

FlorianDeconinck commented 7 months ago

We have sphinx setup, no need for doxygen

xyuan commented 7 months ago

that is great, though. would this document be separated for pace, fv3, shield, or just pace is enough