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.

Sign up for GitHub

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

Jump to bottom

Add links to the main page of UPP doxygen documentation #391

Closed
edwardhartnett opened this issue Sep 24, 2021 · 8 comments
Closed

Add links to the main page of UPP doxygen documentation #391

edwardhartnett opened this issue Sep 24, 2021 · 8 comments
Assignees
@gspetro-NOAA
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@edwardhartnett
Copy link
Collaborator

The main page of the UPP doxygen based documentation can be see here: https://noaa-emc.github.io/UPP/

The text that appears here is from docs/user_guide.md. This is the landing page for the documentation can should also contain some high-level description of what is in UPP, with links to the utilities and most important library functions, to get the new users started on understanding the UPP package.
@fossell
Copy link
Contributor

fossell commented Sep 24, 2021

@edwardhartnett - docs/user_guide.md is essentially a copy of docs/Introduction.rst. Do you know if it is possible for the doxygen documentation to leverage this existing introduction rst file (or perhaps vice versa) instead of having two separate identical copies to maintain? Or is there inherent incompatibility?

@edwardhartnett
Copy link
Collaborator Author

There is no inherent incompatibility. I believe that doxygen can also generate the usethedocs documentation, from the same source.

However, I have not worked that out yet. Also it's not clear that this is as important as it may seem. The readthedocs documentation seems to be more high-level, and the doxygen documentation more code-level, and that's OK. ;-)

So there is some duplication in the docs, for example on UFS_UTILS and NCEPLIBS-bufr, but we just live with it for now.

EricJames-NOAA pushed a commit to EricJames-NOAA/UPP that referenced this issue Dec 14, 2022
@gsketefian
Enable fetching of FV3GFS files from NOAA HPSS after 202002600 (as we…
06b80ec 
…ll as before) for both nemsio and grib2 formats (NOAA-EMC#391)

## DESCRIPTION OF CHANGES:
* Modify workflow script get_extrn_mdl_dir_file_info.sh to enable fetching of FV3GFS files from NOAA HPSS on and after 202002600, which was broken due to a change in file naming convention on HPSS starting on this date.  
  * Files before this date (and after 20190612, which is the start of operations for FV3GFS) can still be fetched as usual.
  * New code works for both nemsio-formatted and grib2-formatted FV3GFS files on HPSS.
* Add 10 new WE2E test configurations to test this capability (both for nemsio and of grib2 formatted files) for five different dates.  Dates chosen as follows:
  * 2019061200:  Date on which FV3GFS becomes operational.  Appears in if-statement in get_extrn_mdl_dir_file_info.sh.
  * 2020022600:  Date on which there is a change in the naming convention of FV3GFS files on HPSS.  Appears in if-statement in get_extrn_mdl_dir_file_info.sh.
  * 2020022518:  Date right before the one on which there is a change in the naming convention of FV3GFS files on HPSS (i.e. 2020022600).
  * 2019101800:  Date about halfway between the date on which FV3GFS becomes operational (2019061200) and the one on which there is the change in file naming convention (2020022600).
  * 2021010100:  Date after the one on which there is a change in file naming convention (2020022600) and is very recent.
* Rename the preexisting WE2E tests that get files from NOAA HPSS so that they use the same naming convention as the five new WE2E tests.


## TESTS CONDUCTED:
On Hera, ran the 10 new WE2E tests for fetching FV3GFS files from HPSS for various dates.  All succeeded.
EricJames-NOAA pushed a commit to EricJames-NOAA/UPP that referenced this issue Dec 14, 2022
@TrevorAlcott-NOAA
Add new job and script to allow model initialization using ICs/LBCs f…
2efcb97 
…rom another RRFS run (NOAA-EMC#391)
@fossell
Copy link
Contributor

fossell commented May 2, 2023

@gspetro-NOAA - This issue was to add more information, helpful links, etc. to the doxygen landing page (https://noaa-emc.github.io/UPP/) which is defined under docs/user_guide.md. Up to you how to enhance this space.

@FernandoAndrade-NOAA FernandoAndrade-NOAA added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 15, 2023
@WenMeng-NOAA
Copy link
Collaborator

@gspetro-NOAA Do you think this issue has been solved? if so, can we close it?

@gspetro-NOAA
Copy link
Collaborator

@WenMeng-NOAA It hasn't yet, but I can put this info in with my upcoming PR.

@WenMeng-NOAA
Copy link
Collaborator

@gspetro-NOAA Thanks for update.

@edwardhartnett
Copy link
Collaborator Author

Can this issue be closed yet?

@gspetro-NOAA gspetro-NOAA mentioned this issue Aug 5, 2024
Merged
@gspetro-NOAA
Copy link
Collaborator

PR #965 added more information, helpful links, etc. to the Doxygen landing page defined in doc/user_guide.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gspetro-NOAA gspetro-NOAA

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@fossell @edwardhartnett @WenMeng-NOAA @gspetro-NOAA @FernandoAndrade-NOAA