Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions doc/IMPORTANT_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# Important Notes on Experimental Features of CTSM
---

Namelist items that are not regularly tested or used. Some aren't even implemented.
## Namelist items not regularly tested or used (some aren't even implemented)

See
See '../bld/namelist_files/namelist_definition_ctsm.xml' -- for definitions of all namelist variables

'../bld/namelist_files/namelist_definition_ctsm.xml' -- for definitions of all namelist variables
### CTSM experimental namelist items

## CTSM experimental namelist items

The following are tested but not on by default (for any physics)
The following are tested but not on by default (for any physics):

- all_active
- allow_invalid_gdd20_season_inputs
- h2osfcflag (deprecated)
- use_nvmovement
- use_soil_moisture_streams

The following are NOT currently tested nor turned on by default:
The following are NOT currently tested nor turned on by default:

- allowlakeprod
- allow_invalid_swindow_inputs
Expand Down Expand Up @@ -54,15 +53,14 @@ Namelist items that are not regularly tested or used. Some aren't even implement
- use_vichydro (deprecated)
- vcmax_opt = 4

## FATES experimental namelist items
### FATES experimental namelist items

FATES is a relatively new subcomponent of CTSM
Almost all FATES options include "fates" in the name
FATES is a relatively new subcomponent of CTSM. Almost all FATES options include "fates" in the name.

The following are tested, but not turned on by default:
The following are tested, but not turned on by default:

- fates_seeddisp_cadence > 0
- fates_parteh_mode > 1
- fates_parteh_mode == carbon_nitrogen
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adrifoster I'm asking for your review of this FATES-related docs PR. Notes:

  • Only line 63 is relevant to the title of the PR.
  • The rest are formatting changes to get the .md file to render as a readable page in the docs rather than as a hard-to-read single-line string.

You can build the docs in my PR using Sam R.'s new tool ./preview_docs_pr if you want to see what I mean.

- use_fates_planthydro
- use_fates_managed_fire
- use_fates_tree_damage
Expand All @@ -71,7 +69,7 @@ Namelist items that are not regularly tested or used. Some aren't even implement
- use_fates_potentialveg
- use_fates_ed_st3

The following are NOT currently tested nor turned on by default:
The following are NOT currently tested nor turned on by default:

- fates_spitfire_mode == 2
- fates_spitfire_mode == 5
Expand All @@ -84,4 +82,3 @@ Namelist items that are not regularly tested or used. Some aren't even implement
- use_fates_potentialveg
- use_fates_daylength_factor == FALSE
- fates_history_dimlevel == 0

Loading