search

NCAR / ccpp-doc

Technical Documentation for the Common Community Physics Package (CCPP)
0 stars 33 forks source link

Update the chapter on Adding a new scheme to CCPP #68

Closed mkavulich closed 11 months ago

mkavulich commented 12 months ago

This chapter more thoroughly describes the process of adding a new scheme to CCPP. Includes instructions on logistics (adapting scheme to CCPP-compliance vs using a driver), adding new variables, and debugging a scheme once added. Also included a new glossary definition for "entry point".

This PR also includes a new .readthedocs.yaml file, which is now required for auto-builds on ReadTheDocs

Link to this branch's built documentation: https://mike-k-tech-doc.readthedocs.io/en/latest/AddingNewSchemes.html

mkavulich commented 12 months ago

@ligiabernardet thanks for your further comments, I have applied most of your suggested changes and have just a few questions.

The updating of the "v6" links is tough in the main branch because the only more up-to-date scientific docs are SRW-release-specific. Do you think it's appropriate to include those more up-to-date links in this main branch even though they are specific to SRW?

Edit: I misread your comment at first, you were referring to the page titles. I will add those updates shortly, but I do still have the question about links.

ligiabernardet commented 11 months ago

The updating of the "v6" links is tough in the main branch because the only more up-to-date scientific docs are SRW-release-specific. Do you think it's appropriate to include those more up-to-date links in this main branch even though they are specific to SRW?

Please tell me which links you are referring to. Tks