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 HAFS HYCOM, WW3 and CDEPS_DOCN coupling related documentation #864

Merged

Conversation

danrosen25
Copy link
Collaborator

@danrosen25 danrosen25 commented Oct 8, 2021

PR Checklist

  • Ths PR is up-to-date with the top of all sub-component repositories except for those sub-components which are the subject of this PR. Please consult the ufs-weather-model wiki if you are unsure how to do this.

  • This PR has been tested using a branch which is up-to-date with the top of all sub-component repositories except for those sub-components which are the subject of this PR

  • An Issue describing the work contained in this PR has been created either in the subcomponent(s) or in the ufs-weather-model. The Issue should be created in the repository that is most relevant to the changes in contained in the PR. The Issue and the dependent sub-component PR
    are specified below.

  • If new or updated input data is required by this PR, it is clearly stated in the text of the PR.

Description

This PR addresses missing documentation for HAFS related HYCOM, CDEPS-DOCN and WW3 coupling.

  • add to code overview
  • added build settings for HAFS and HAFSW
  • added app names HAFS and HAFSW
  • new section for HYCOM input
  • added blkdat.input to list of files
  • added HAFS application sample
  • new section added to point to external blkdat.input documentation
  • new section for HYCOM output
  • added HAFS WW3 and CDEPS-DOCN coupling related documentation

Co-authored-by: @BinLiu-NOAA, @hyunsookkim-NOAA, @uturuncoglu, @JessicaMeixner-NOAA, @aliabdolali

Issue(s) addressed

Testing

  • Built html documentation on local Darwin machine.

Dependencies

  • No dependencies. Documentation changes only.

* add to code overview
* added build settings for HAFS and HAFSW
* added app names HAFS and HAFSW
* new section for HYCOM input
* added blkdat.input to list of files
* added HAFS application sample
* new section added to point to external blkdat.input documentation
* new section for HYCOM output

Co-authored-by: Bin Liu <Bin.Liu@noaa.gov>
Co-authored-by: Hyun-Sook Kim <hyun.sook.kim@noaa.gov>
@junwang-noaa
Copy link
Collaborator

@rmontuoro FYI, here is HYCOM documentation PR.

@binli2337
Copy link
Contributor

In inputs.outputs.rst, the application 'HAFS-ALL" is missing in the list of supported ufs-weather-model applications.

@junwang-noaa junwang-noaa added No Baseline Change No Baseline Change Ready for Commit Queue The PR is ready for the Commit Queue. All checkboxes in PR template have been checked. labels Oct 12, 2021
@junwang-noaa junwang-noaa added Waiting for Reviews The PR is waiting for reviews from associated component PR's. and removed Ready for Commit Queue The PR is ready for the Commit Queue. All checkboxes in PR template have been checked. labels Oct 12, 2021
* add HAFS-ALL app
* update HYCOM blkdat.input setting descriptions
@danrosen25
Copy link
Collaborator Author

In inputs.outputs.rst, the application 'HAFS-ALL" is missing in the list of supported ufs-weather-model applications.

@BinLiu-NOAA Done

@uturuncoglu
Copy link
Collaborator

@danrosen25 I think I created initial version of WW3 document and you could find it in the following link,

https://docs.google.com/document/d/1pS0MQdenb6XsuuJ9y8lyUJsQ5q3mg3kn-T9uKmWkAZI/edit

It might help.

@danrosen25
Copy link
Collaborator Author

danrosen25 commented Oct 13, 2021

@uturuncoglu

The ufs-weather-model documentation is focused on building forecast apps and the input and output for each app. It's a user's guide.
https://ufs-weather-model.readthedocs.io/en/latest/

@danrosen25 danrosen25 marked this pull request as draft November 2, 2021 15:55
@danrosen25 danrosen25 marked this pull request as ready for review November 3, 2021 15:16
@BinLiu-NOAA BinLiu-NOAA changed the title Add HAFS, HYCOM and CDEPS_DOCN documentation Add HAFS HYCOM, WW3 and CDEPS_DOCN coupling related documentation Nov 5, 2021
Copy link
Contributor

@BinLiu-NOAA BinLiu-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 good to me.

@climbfuji
Copy link
Collaborator

@binli2337 Can you confirm that this PR is ready to go? @JessicaMeixner-NOAA @junwang-noaa please check again and approve if ok. Thanks!

@climbfuji
Copy link
Collaborator

@BinLiu-NOAA Ready to merge?

@BinLiu-NOAA
Copy link
Contributor

@BinLiu-NOAA Ready to merge?

@climbfuji, I think it is ready to merge. Thanks!

@climbfuji climbfuji merged commit dded6d9 into ufs-community:develop Nov 5, 2021
@climbfuji
Copy link
Collaborator

@rmontuoro HAFS documentation merged - your turn please!

@BinLiu-NOAA BinLiu-NOAA deleted the feature/doc_hafs_hycom_docn branch November 20, 2021 00:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No Baseline Change No Baseline Change Waiting for Reviews The PR is waiting for reviews from associated component PR's.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for HAFS HYCOM/WW3/CDEPS coupling related developments
9 participants