search

OMS-NetZero / FAIR

Finite-amplitude Impulse Response simple climate model
https://docs.fairmodel.net
Apache License 2.0
123 stars 62 forks source link

Add documentation #23

Closed chrisroadmap closed 11 months ago

chrisroadmap commented 6 years ago

Ideally, example usage of most of the inputs to fair_scm. Documentation is strongly encouraged for GMD submissions and will be necessary for users.

I have kicked this off with the documentation branch, using Sphinx and reStructuredText files.

chrisroadmap commented 6 years ago

Now merged into master at v1.3. Still needs a function-by-function index - most functions have docstrings but rather unhelpfully fair_scm does not - this is still a to do.

chrisroadmap commented 11 months ago

finally achieved in v2.1 :partying_face: