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

Add instructions for the gdas_init utility to readthedocs #920

Merged
merged 17 commits into from
Mar 18, 2024

Conversation

GeorgeGayno-NOAA
Copy link
Collaborator

DESCRIPTION OF CHANGES:

Add section to readthedocs for the gdas_init utility.

TESTS CONDUCTED:

N/A

DEPENDENCIES:

NOAA-EMC/global-workflow#2397

DOCUMENTATION:

https://georgegayno-noaaufs-utils.readthedocs.io/en/gi_doc/ufs_utils.html#gdas-init

ISSUE:

Fixes #915.

@GeorgeGayno-NOAA
Copy link
Collaborator Author

@CatherineThomas-NOAA and @JessicaMeixner-NOAA - Please review.

@GeorgeGayno-NOAA GeorgeGayno-NOAA marked this pull request as ready for review March 15, 2024 13:52
@GeorgeGayno-NOAA GeorgeGayno-NOAA self-assigned this Mar 15, 2024
@JessicaMeixner-NOAA
Copy link

@GeorgeGayno-NOAA this is great! Thank you so much for adding this documentation here. I'm good with this as is, but one place we might point out is the set_fixed_files.sh file and that it's where the ocean resolutions are set as I think some people might be interested in where that is set and how to change if needed. Thanks again for adding this!

@CatherineThomas-NOAA
Copy link
Collaborator

@GeorgeGayno-NOAA Looks great. I second Jessica's comment about the ocean resolution. Thanks so much for addressing this so quickly!

Copy link
Collaborator

@KateFriedman-NOAA KateFriedman-NOAA 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, thanks for adding this @GeorgeGayno-NOAA after we removed it from the global-workflow RTD. Left a few minor comments to consider but I approve pending other reviewer comments.

Once this is in, I will add the link to the UFS_UTILS RTD from the global-workflow RTD so users are directed there for making ICs.

docs/source/ufs_utils.rst Outdated Show resolved Hide resolved
docs/source/ufs_utils.rst Outdated Show resolved Hide resolved
docs/source/ufs_utils.rst Outdated Show resolved Hide resolved
@GeorgeGayno-NOAA
Copy link
Collaborator Author

@GeorgeGayno-NOAA Looks great. I second Jessica's comment about the ocean resolution. Thanks so much for addressing this so quickly!

@JessicaMeixner-NOAA and @CatherineThomas-NOAA - is this OK? 4d85a39

@JessicaMeixner-NOAA
Copy link

@GeorgeGayno-NOAA thank you so much for that update! I think it is clear and will be really helpful to many users!

@CatherineThomas-NOAA
Copy link
Collaborator

Looks great @GeorgeGayno-NOAA. Thanks!

@GeorgeGayno-NOAA GeorgeGayno-NOAA merged commit 72fb94f into ufs-community:develop Mar 18, 2024
4 checks passed
@GeorgeGayno-NOAA
Copy link
Collaborator Author

Looks great, thanks for adding this @GeorgeGayno-NOAA after we removed it from the global-workflow RTD. Left a few minor comments to consider but I approve pending other reviewer comments.

Once this is in, I will add the link to the UFS_UTILS RTD from the global-workflow RTD so users are directed there for making ICs.

Just merged it. Point to this location: https://noaa-emcufs-utils.readthedocs.io/en/latest/

@KateFriedman-NOAA
Copy link
Collaborator

Point to this location: https://noaa-emcufs-utils.readthedocs.io/en/latest/

Great, thanks @GeorgeGayno-NOAA !

@GeorgeGayno-NOAA GeorgeGayno-NOAA deleted the gi_doc branch April 12, 2024 17:27
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.

Add gdas_init utility to readthedocs
4 participants