#141- User responsibilities

[ccarouge]

CABLE

Thank you for submitting a pull request to the CABLE Project.

Description

This is to describe the responsibilities of users. Users are defined as people who are using the code but not modifying it.

Fixes #141

Type of change

Please delete options that are not relevant.

• New or updated documentation

Checklist

• The new content is accessible and located in the appropriate section.
• I have checked that links are valid and point to the intended content.
• I have checked my code/text and corrected any misspellings

Please add a reviewer when ready for review.

---

📚 Documentation preview 📚: https://cable--142.org.readthedocs.build/en/142/

[JhanSrbinovsky]

The current user guide contains documentation of the processes. I can understand if the intention is to seperate the two, but is it clear somewhere that user guide retains to just that and description of the model is elsewhere?

[JhanSrbinovsky]

"awkward workflow" - I would suggest this applies to almost all of CABLE!

[ccarouge]

@JhanSrbinovsky, the structure of the documentation is still in flux. For the moment, the only thing that approaches the model description is the "API" description which points to FORD in the developer guide. We could argue we would need a summary description of the model somewhere that is not split along the code units internal to CABLE. For the moment, this is nowhere. Considering the snail speed at which we are writing the documentation, I have no idea when this overview will exist anyway...