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

Initial Documentation Draft for CEFI-regional-MOM6 #6

Merged
merged 20 commits into from
Mar 1, 2024
Merged

Conversation

yichengt900
Copy link
Contributor

@yichengt900 yichengt900 commented Feb 21, 2024

As titled. This PR adds an online documentation so beginners can learn the basics of the CEFI-regional-MOM6 (e.g. compile/build, brief descriptions of model inputs and outputs, how to run an example experiment). Please feel free to review it and provide any comments for future improvements.

@yichengt900 yichengt900 self-assigned this Feb 21, 2024
@yichengt900 yichengt900 added the documentation Improvements or additions to documentation label Feb 21, 2024
@yichengt900 yichengt900 marked this pull request as ready for review February 27, 2024 19:20
@yichengt900 yichengt900 requested review from charliestock, theresa-morrison, andrew-c-ross and a team and removed request for a team February 27, 2024 20:01
Copy link
Contributor

@andrew-c-ross andrew-c-ross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! I've noted just a few typos and minor suggestions.

@yichengt900
Copy link
Contributor Author

@andrew-c-ross , thanks for your comments! I will address them soon!

@theresa-morrison
Copy link
Contributor

Looks good, I added a bit of text about input/override files which is in a separate PR.

Added some additional info about the input and override files, and a note about the parameter doc files in the "output" section.
@yichengt900 yichengt900 merged commit 521a54a into main Mar 1, 2024
1 check passed
@yichengt900 yichengt900 deleted the feature/doc branch March 3, 2024 00:01
theresa-morrison pushed a commit that referenced this pull request May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants