Skip to content
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

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

hkershaw-brown
Copy link
Member

Description:

  • remove out-of-date info about inflation flavor character strings
  • link to inflation page rather than "program filter" which does not have any inflation info.
  • added a target to the inflation section for linking

Fixes issue

fixes #694

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Built documentation locally

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

link to inflation page rather than "program filter" which does not
have any inflation info.
Copy link
Contributor

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

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

Copy link
Contributor

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

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."

Copy link
Contributor

@mjs2369 mjs2369 left a 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:

DART/guide/inflation.rst

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)

@hkershaw-brown
Copy link
Member Author

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

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".

@hkershaw-brown
Copy link
Member Author

0e04d67

fixed in 0e04d67

@hkershaw-brown
Copy link
Member Author

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."

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.

Copy link
Contributor

@mjs2369 mjs2369 left a 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.

@hkershaw-brown hkershaw-brown added the release! bundle with next release label Aug 28, 2024
@hkershaw-brown hkershaw-brown merged commit 36a0337 into main Aug 29, 2024
4 checks passed
@hkershaw-brown hkershaw-brown deleted the doc-filter-inf branch August 29, 2024 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release! bundle with next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: filter_mod documentation inflation options out-of-date
2 participants