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

Update Auto-generated Ocean User's Guide #77

Merged
merged 4 commits into from
May 28, 2024

Conversation

xylar
Copy link
Contributor

@xylar xylar commented Feb 29, 2024

This was generated with the latest MPAS-Ocean registry from E3SM's master branch and from this updated tool:
https://github.com/xylar/MPAS-Tools/blob/update-parse-registry/python_scripts/namelist_generation/parse_xml_registry.py

Copy link
Contributor

@mark-petersen mark-petersen left a comment

Choose a reason for hiding this comment

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

I reviewed the document and everything is in order. Thank you for this! My only comment is to update the version and date on the first page.

@xylar
Copy link
Contributor Author

xylar commented Apr 27, 2024

@mark-petersen, I generated a new registry using this E3SM hash: E3SM-Project/E3SM@cd40745

This is essentially identical to the 3.0.0 tag except for a few formatting fixes and clarifications in descriptions of namelist options.

I updated the auto-generated documentation with that version:
mpas_ocean_users_guide.pdf (out of date, replaced below).

@mark-petersen
Copy link
Contributor

One more. Please delete the current text of the forward page, including the names at the bottom. This revised text is important for anyone who happens to see this. Please simply use this text for the Forward:

This User's Guide is for the Model for Prediction Across Scales-Ocean (MPAS-Ocean), the ocean component of the Energy Exascale Earth System Model (E3SM), developed by the U.S. Department of Energy. Herein we describe the equations, namelist options, and variables for MPAS-Ocean. These settings apply to both the standalone ocean-only version of MPAS-Ocean, and E3SM version that is coupled to the atmosphere, sea ice, land ice, land and river components.

The MPAS-Ocean code for both standalone and coupled is housed in the repository https://github.com/E3SM-Project/E3SM, within the directory components/mpas-ocean. The standalone executable may be built within that directory using the make command with the required libraries, as described in Chapter 1 of this guide.

Documentation for the E3SM coupled climate model may be found on the E3SM docs pages, the E3SM Documentation webpage, or the E3SM repository homepage.

@xylar
Copy link
Contributor Author

xylar commented Apr 27, 2024

@mark-petersen and @alicebarthel, here is the latest version as requested:
mpas_ocean_users_guide.pdf

Here is a screenshot of the forward, for your convenience:
Screenshot from 2024-04-27 16-46-41

@mark-petersen mark-petersen merged commit b25fce3 into MPAS-Dev:master May 28, 2024
@mark-petersen
Copy link
Contributor

I forgot to merge this before. Thanks @xylar, this was very useful for the documentation and tutorial.

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.

None yet

2 participants