-
Notifications
You must be signed in to change notification settings - Fork 145
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc-fix: remove out-of-date info about inflation flavor character strings #715
Conversation
2ff38d7
to
cc89f53
Compare
link to inflation page rather than "program filter" which does not have any inflation info.
cc89f53
to
d4d8d11
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DART/assimilation_code/modules/assimilation/filter_mod.rst
Lines 96 to 97 in d4d8d11
The inflation control variables are all dimensioned 2, the first value controls the | |
prior inflation and the second controls the posterior inflation. |
duplicate info that's in the table at line 273
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DART/assimilation_code/modules/assimilation/filter_mod.rst
Lines 7 to 8 in d4d8d11
Main module for driving ensemble filter assimilations. Used by filter.f90, perfect_model_obs.f90, model_mod_check.f90, | |
and a variety of test programs. See the :doc:`../../programs/filter/filter` for a general description of filter |
Think it's more useful here to use the program names, i.e:
"Used by the filter, perfect_model_obs, and model_mod_check programs, as well as a variety of test programs."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| filter_main | inf_flavor= ### Must be 0, 2, 3. | Observation Inflation is no longer supported (i.e flavor 1). | |
Don't think this is true that the only valid options are 0, 2, and 3? And in the inflation.rst doc it says otherwise:
Lines 47 to 57 in d4d8d11
``&filter_nml :: inf_flavor`` | |
*valid values:*\ 0, 2, 3, 4, 5 | |
Set the type of Prior and Posterior inflation applied to the state vector. Values mean: | |
- **0:** No inflation (Prior and/or Posterior) and all other inflation variables are ignored | |
- [**1:** Deprecated: Observation space inflation] | |
- **2:** Spatially-varying state space inflation (gaussian) | |
- **3:** Spatially-uniform state space inflation (gaussian) | |
- **4:** Relaxation To Prior Spread (Posterior inflation only) | |
- **5:** Enhanced Spatially-varying state space inflation (inverse gamma) |
I think the intent of this is to stress the inflation options have a prior and posterior. If someone does not bother to read this whole table, then this gives the "Particular options to be aware of". |
I could see either way, the .f90 is which file has the "use filter_mod". I'd say leave as is since this pull request is to fix the inflation options docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, that all makes sense to me. Ready to go into main then.
Description:
Fixes issue
fixes #694
Types of changes
Documentation changes needed?
Tests
Built documentation locally
Checklist for merging
Checklist for release
Testing Datasets