Documentation on adding diagnostic output. #331
Conversation
There was a problem hiding this comment.
This doesn't address what happens when a desired variable is buried within layers of subroutines and not easily accessible via a use statement.
@dabail10 does this capture the challenges you faced when adding the isotopes? Conservation was a different issue but still required some additional output, right?
|
|
||
| - If the variable is just a scalar, then follow the example of "aice". Copy the write statement for Qa to | ||
| a place in the output list where it is most appropriate. The format "900" is appropriate for most scalars. | ||
| Edit the copied statement to be the variable you want. The following example adds snow-melt (melts). |
There was a problem hiding this comment.
Here is would add what n is, e.g.
The following example adds snow melt (melts) for each of the n points.
(no hyphen needed)
There was a problem hiding this comment.
I've added a bit more here. Hopefully this is helpful.
| - If the variable is already defined within the code, then add it to a "use" statement in the subroutine | ||
| ``hbrine_diags`` or ``bgc_diags`` or ``zsal_diags``. The similar procedure for state variables is used here. | ||
|
|
||
| - Note that the BGC needs to be activited and the particular tracer turned on. |
|
Right! I also need to add an example when a variable needs to be derived from other variables. |
|
This issue has popped back up in the forum, so maybe we should raise its priority... |
|
I've incorporated Elizabeth's changes here and the readthedocs is building fine. I've also added a fix to the documentation as found by @JFLemieux73. |
|
I will wait for @JFLemieux73 to have a look. The conservation diagnostics are on my list. |
|
Thanks Dave for the correction in the section Shortwave radiation: CCSM3. It's ok. |
* Initialize revp stresses to previous time step * Add machine files for brooks * Modify the documentation about stress initialization in revised evp
For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium,
please refer to: https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers
PR checklist
This is only a documentation update.
dabail10 (D. Bailey)
I will make sure this builds in readthedocs via the Travis check.
This is a starting point for the tips on adding diagnostics. I am open to suggestions. This addresses issue Document how to add diagnostic output #317.