Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@hkershaw-brown
Copy link
Member

@hkershaw-brown hkershaw-brown commented Jun 15, 2022

Description:

var observation converter was not being built by quickbuild.sh
Added the 3DVAR_OBSPROC directory to quickbuild.sh so the build completes successfully.

Fixes issue

Fixes #361

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:
      Fixed broken WRFDA link in README and added where to find the list of WRF files to var.rst

Tests

Compiled converter:

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Version tag

Same release as #363

Testing Datasets

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

@hkershaw-brown hkershaw-brown requested a review from mjs2369 June 15, 2022 18:08
@hkershaw-brown
Copy link
Member Author

@mjs2369 Hi Marlee, when you get a chance can you review this pull request. For the review, looking for:

  • check that the instructions for getting the WRFDA code, and where to copy the WRFDA code to make sense.
  • check that the converter programs actually compile.

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.

Line 21 of observations/obs_converters/var/3DVAR_OBSPROC/README should have the directory as WRF/var/obsproc/MAP_plot/include as oppsosed to WRFDA/var/obsproc/MAP_plot/include, which doesn't exist (i.e. there is no /var directory in the WRFDA repo). The converter was tested and successfully compiled with the files found in WRF/var/obsproc/MAP_plot/include.

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.

Adding a link to the WRF repo, as well as clarifying the directory the files need to be copied into, may eliminate some difficulties for our users.

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.

There seem to be two redundant links in DART/observations/obs_converters/var/var.rst

The links on lines 14 and 15, for :doc:./littler_tf_dart and :doc:./rad_3dvar_to_dart, lead to the current page (var.rst). Or in other words, the links don't take you anywhere.

@mjs2369
Copy link
Contributor

mjs2369 commented Jun 16, 2022

Helen, in addition to the comments above, there is the issue we discussed in which var.rst can only be found on the documentation website when searching for it (https://dart-documentation--362.org.readthedocs.build/en/362/observations/obs_converters/var/var.html?highlight=var). It can not be found in the list of docs for converter programs or elsewhere in the menu.

The changes made to the code allowed for a successful compile of the var converter using ./quickbuild.

@hkershaw-brown
Copy link
Member Author

Line 21 of observations/obs_converters/var/3DVAR_OBSPROC/README should have the directory as WRF/var/obsproc/MAP_plot/include as oppsosed to WRFDA/var/obsproc/MAP_plot/include, which doesn't exist (i.e. there is no /var directory in the WRFDA repo). The converter was tested and successfully compiled with the files found in WRF/var/obsproc/MAP_plot/include.

done.

@hkershaw-brown
Copy link
Member Author

Helen, in addition to the comments above, there is the issue we discussed in which var.rst can only be found on the documentation website when searching for it (https://dart-documentation--362.org.readthedocs.build/en/362/observations/obs_converters/var/var.html?highlight=var). It can not be found in the list of docs for converter programs or elsewhere in the menu.

The changes made to the code allowed for a successful compile of the var converter using ./quickbuild.

Added var to the list of obs converters

@hkershaw-brown
Copy link
Member Author

There seem to be two redundant links in DART/observations/obs_converters/var/var.rst

The links on lines 14 and 15, for :doc:./littler_tf_dart and :doc:./rad_3dvar_to_dart, lead to the current page (var.rst). Or in other words, the links don't take you anywhere.

The links work correctly in readthedocs output: https://dart-documentation--362.org.readthedocs.build/en/362/observations/obs_converters/var/var.html

but unfortunately the links do not work in GitHub. Possibly someone has solved this problem, but fixing this for the DART docs is out of scope for this

We are not the only people to have this problem, here is VAPOR's docs:
https://vapor.readthedocs.io/en/readthedocs/quickStartGuide.html
and here is what the rst for that page looks like on Github:
https://github.com/NCAR/VAPOR/blob/readTheDocs/docs/quickStartGuide.rst

@hkershaw-brown hkershaw-brown requested a review from mjs2369 June 17, 2022 16:06
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.

Everything looks good and I believe it is ready to merge with main.

@hkershaw-brown hkershaw-brown merged commit da1803b into main Jun 24, 2022
@hkershaw-brown hkershaw-brown deleted the var-quickbuild-fix branch June 24, 2022 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

var converter quickbuild.sh missing WRFDA code

3 participants