-
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
obs_impact_tool documentation improvements #655
obs_impact_tool documentation improvements #655
Conversation
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.
Looks good. I suggested a minor change to the wording to be more clear about the tool vs output from the tool.
Co-authored-by: nancy collins <[email protected]>
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.
This is good start Charlotte.
At the moment this documentation is describing what the code does, rather than how to use it.
The user wants to restrict the impact of some observations on some quantities.
How do they do that?
- build obs_impact_tool
- create a cross_correlations.txt where you define the impacts.
- Run obs_impact_tool to create control_impact_runtime.txt
- Use this contrpol_impact_runtime.txt file in your assimilation by setting:
&assim_tools_nml
adjust_obs_impact = .true.
obs_impact_filename = 'control_impact_runtime.txt'
/
Let's chat today about next steps. This documentation page (both the existing and the changes) is a good candidate for taking a look at with the documentation style guide short summary
https://developers.google.com/style.
Cheers,
Helen
following google documentation style guide(ish)
@c-merchant approved changes |
Description:
I added "Filter Use" and "Building" sections and details to obs_impact_tool docs and deleted typo in assim_tools_mod.rst.
Fixes issue
PR intends to fix issue #571
Types of changes
Documentation changes needed?
Tests
I ran the standard ./quickbuild.sh, ./perfect_model_obs, and ./filter for Lorenz-63 to make sure no bugs were introduced.
Checklist for merging
Checklist for release
Testing Datasets