obs_impact_tool documentation improvements - Githubissues

NCAR / DART

Data Assimilation Research Testbed

https://dart.ucar.edu/

Apache License 2.0

184 stars 138 forks source link

obs_impact_tool documentation improvements #655

Closed c-merchant closed 2 months ago

c-merchant commented 3 months ago

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

[ ] 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)
[x] Documentation update

Documentation changes needed?

[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.

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

[ ] Updated changelog entry
[x] 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
[x] No dataset needed

hkershaw-brown commented 2 months ago

@c-merchant approved changes