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

Adding diagnostics to WRF-DART documentation #544

Merged
merged 8 commits into from
Oct 5, 2023
Merged

Conversation

braczka
Copy link
Contributor

@braczka braczka commented Sep 22, 2023

Description:

Added a more complete diagnostics section to the WRF-DART Tutorial.

Fixes issue

Address issue #543

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

I used diagnostic output from a WRF Tutorial example I have already run. The
BASEDIR is located here: /glade/scratch/bmraczka/WRF_DART_Tut4. The analysis_increment.nc,
obs_epoch_029.nc and obs_diag_output.nc files, in which I tested the new diagnostic section with
are located in ~/output/2017042712/.

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

@braczka braczka added Documentation Improvements or additions to documentation wrf Weather Research & Forecasting Model labels Sep 22, 2023
@braczka braczka self-assigned this Sep 22, 2023
@hkershaw-brown
Copy link
Member

note for reviewers, the readthedocs for this pull request can be viewed can be viewed here:
https://dart-documentation--544.org.readthedocs.build/en/544/models/wrf/tutorial/README.html#step-6-diagnosing-the-assimilation-results

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.

@braczka this documentation is great. I have a few questions and comments, but overall this could be merged now. Let me know what you think about the following comments and I can go ahead and approve this PR.

It might be useful here to include a link to our documentation page that details the other QC values and their reason for rejection.
"See the 'DART quality control field page' (https://docs.dart.ucar.edu/en/latest/guide/dart-quality-control.html) for more information on the other values for QC and their reason for rejection"

This is more of a question I have personally, but what determines the vertical axis for the different plots? Most of the diagnostic plots use pressure, but this plot uses surface. Is it simply the type of observation and what that type uses as a vertical coordinate that determines this?

In the Quantification of model-observation mismatch and ensemble spread section of the diagnostics, the ensemble statistic total spread is used explicitly (copy = 'totalspread';). Are there other useful ensemble statistics other than total spread that could used for these plot_rmse figures and should be mentioned here?

It may be useful here to give some examples of these modifiable pre-set options.

@hkershaw-brown hkershaw-brown added the release! bundle with next release label Sep 28, 2023
@braczka
Copy link
Contributor Author

braczka commented Oct 4, 2023

Latest commits addresses comments by @mjs2369. Also got rid of unrelated and annoying footnote build errors in CLM documentation to partially address issue #546

Only pinned sphinx and sphinx_rtd_theme. May want to revist this
and pin everything.
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.

Looks great! Approved.

@hkershaw-brown hkershaw-brown merged commit 713dd3f into main Oct 5, 2023
3 checks passed
@hkershaw-brown hkershaw-brown deleted the WRF_documentation branch October 16, 2023 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation release! bundle with next release wrf Weather Research & Forecasting Model
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants