Update UFS-UTILS documentation to include all utilities needed for SRW app release

[jwolff-ncar]

Each of these utilities is envisioned to be part of UFS_UTILS prior to the SRW App Release (list below still needs to be firmed up). Given that, each utility should have a chapter in the UFS-UTILS documentation to be hosted through ReadtheDocs.

make_hgrid orog regional_grid global_equiv_resol shave filter_topo chgres_cube: already exists - simply need to update as necessary for SAR

[jwolff-ncar]

@GeorgeGayno-NOAA As new utilities are added into the UFS_UTILS repo, are there plans to expand this documentation (https://ufs-utils.readthedocs.io/en/ufs-v1.0.0/) to make it applicable for all utilities in the repo? This will be necessary for the SRW app release.

[GeorgeGayno-NOAA]

Each of these utilities is envisioned to be part of UFS_UTILS prior to the SRW App Release (list below still needs to be firmed up). Given that, each utility should have a chapter in the UFS-UTILS documentation to be hosted through ReadtheDocs.

make_hgrid orog regional_grid global_equiv_resol shave filter_topo chgres_cube: already exists - simply need to update as necessary for SAR

@jwolff-ncar Need to add the "regional_esg_grid" program - for the extended Schmidt gnomonic grids (the "Jim Purser" grid)

[GeorgeGayno-NOAA]

@GeorgeGayno-NOAA As new utilities are added into the UFS_UTILS repo, are there plans to expand this documentation (https://ufs-utils.readthedocs.io/en/ufs-v1.0.0/) to make it applicable for all utilities in the repo? This will be necessary for the SRW app release.

@jwolff-ncar Can I create a google doc for this? I don't know how to work with rst files.

[GeorgeGayno-NOAA]

Each of these utilities is envisioned to be part of UFS_UTILS prior to the SRW App Release (list below still needs to be firmed up). Given that, each utility should have a chapter in the UFS-UTILS documentation to be hosted through ReadtheDocs. make_hgrid orog regional_grid global_equiv_resol shave filter_topo chgres_cube: already exists - simply need to update as necessary for SAR

@jwolff-ncar Need to add the "regional_esg_grid" program - for the extended Schmidt gnomonic grids (the "Jim Purser" grid)

Oh, I meant regional_grid, should be regional_esg_grid.

[GeorgeGayno-NOAA]

I started a google doc: https://docs.google.com/document/d/1syxLQfh5qOI5AxOxc3OEmf2LXbF6jV-pnn5ra6syhGA/edit?usp=sharing

[jwolff-ncar]

@GeorgeGayno-NOAA Thank you for your continuing work on the Google Doc. We will worry about transitioning it to RST format later. I do want to mention that as we enhance the UFS_UTILS documentation to include the new utilities, we will want to keep in mind that anything that is specific for the SRW application should go directly in the SRW App Users' Guide. And anything that is general that would work with any application should go in the UFS_UTILS documentation. Does that make sense? We just need to make note of these subtleties for now and push things to the correct location as we finalize the documentation. Thanks!

[jwolff-ncar]

@GeorgeGayno-NOAA Just an FYI that documentation needs to be finalized by 20 Nov. Please let me know when you are ready for a review of the content - at any stage - happy to do that in pieces if that works better for you.

[GeorgeGayno-NOAA]

I started a google doc: https://docs.google.com/document/d/1syxLQfh5qOI5AxOxc3OEmf2LXbF6jV-pnn5ra6syhGA/edit?usp=sharing

@jwolff-ncar I started this google doc for the grid generation programs. It is a rough draft, but your initial comments are welcome. Also, I know nothing about the orography filtering program - the method used, the meaning of the namelist coefficients, etc. Can you reach out to GFDL for help?

[jwolff-ncar]

I can reach out ot GFDL for assistance with the orography filtering program. Do you want me to send them a link to your Google Doc? Then they can ask for edit privileges.

Ultimately, I assume that this page: https://ufs-utils.readthedocs.io/en/latest/ will become a full users guide for all of the components in UFS UTILS. So, what is there now (chgres_cube) will be one chapter and the others you are now adding will follow. If you agree, each chapter should follow the same flow as what has been established for chgres_cube where it makes sense. It might be nice to have the structure in place (in the Google Doc) prior to sharing the document with GFDL so we can focus on where their contributions fit in more easily. Thoughts?

On Thu, Oct 22, 2020 at 12:38 PM GeorgeGayno-NOAA notifications@github.com wrote:

I started a google doc: https://docs.google.com/document/d/1syxLQfh5qOI5AxOxc3OEmf2LXbF6jV-pnn5ra6syhGA/edit?usp=sharing

@jwolff-ncar https://github.com/jwolff-ncar I started this google doc for the grid generation programs. It is a rough draft, but your initial comments are welcome. Also, I know nothing about the orography filtering program - the method used, the meaning of the namelist coefficients, etc. Can you reach out to GFDL for help?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/NOAA-EMC/UFS_UTILS/issues/103#issuecomment-714684330, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFN5ZDDFALEIC2MQUDBYQ53SMB34DANCNFSM4M7DENYQ .

--

Jamie K. Wolff National Center for Atmospheric Research (NCAR) Research Applications Laboratory (RAL) Phone: 303.497.2812 Email: jwolff@ucar.edu

My working day may not be your working day. Please do not feel obliged to reply to this email outside of your normal working hours.

[GeorgeGayno-NOAA]

Yes, I can give GFDL edit privileges.

Yes, creating a chapter for each component makes sense. And so does restructuring the document prior to sharing it with others.

[jwolff-ncar]

Also tagging @JeffBeck-NOAA and @LarissaReames-NOAA as they make updates for the regional application.

[jwolff-ncar]

@GeorgeGayno-NOAA Please let @JeffBeck-NOAA @LarissaReames-NOAA and me know when your full UFS_UTILS Users Guide is ready for further review.

We can review the Google Doc: https://docs.google.com/document/d/1syxLQfh5qOI5AxOxc3OEmf2LXbF6jV-pnn5ra6syhGA/edit?usp=sharing

And we can review the readthedocs: https://ufs-utils.readthedocs.io/en/latest/ once that has been updated to include all of the chapters for the utilities included.

I assume that the readthedocs will have a tag for the v2 public release but we can work out those details later.

[edwardhartnett]

Has this been completed?

[GeorgeGayno-NOAA]

Has this been completed?

Almost done.

[GeorgeGayno-NOAA]

Working under this branch: 2857ff8