Add general project documentation

m2lines / gz21_ocean_momentum

Stochastic-Deep Learning Parameterization of Ocean Momentum Forcing

MIT License

5 stars 0 forks source link

Add general project documentation #18

Closed jatkinson1000 closed 9 months ago

jatkinson1000 commented 1 year ago

Add project documentation in README.md to address:

Add a "how to cite this software" snippet
Installation procedure
- @raehik to do this once #13 is complete
Running procedure
Results

Do we need more detail? Sphinx or readthedocs? Probably not at the moment.

MarionBWeinzierl commented 1 year ago

Some of this was addressed in #60 .

Still to do:

[ ] A CITATION.cff file could be added providing a formatted citation snippet. (alternatively: section in README)
[ ] More information on the model outputs should be provided.

raehik commented 9 months ago

CITATION.cff added in #99. I've elaborated on your model documentation in #106 -- in short, it exists in the paper, but it doesn't discuss implementation details, so we should add those.

Otherwise, with the readme expanded (and some extra stuff pending in #97), I think this issue is OK to close.