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 ISOMIP+ docs, including tutorial for Ocean0 on LANL IC #653

Merged
merged 3 commits into from
Aug 17, 2020

Conversation

xylar
Copy link
Collaborator

@xylar xylar commented Aug 12, 2020

This is updated in the documentation, rather than in the local README.

This merge also removes the README in ISOMIP+ COMPASS directory because it is now redundant (and out of date).

xylar added 2 commits August 12, 2020 17:28
This is updated in the documentaiton, rather than in the local
README.
This is redundant now that this example is in the docs.
@xylar xylar added Ocean COMPASS Documentation only Changes that impact code comments and documentation, but no executable code labels Aug 12, 2020
@xylar xylar requested a review from cbegeman August 12, 2020 15:38
@xylar xylar mentioned this pull request Aug 12, 2020
Copy link

@cbegeman cbegeman left a comment

Choose a reason for hiding this comment

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

@xylar This is great, thanks for writing this up so thoroughly! I had no trouble following the documentation/tutorial after the minor changes you made.

@xylar xylar changed the title Update ISOMIP+ Ocean0 on LANL IC example Update ISOMIP+ docs, including tutorial for Ocean0 on LANL IC Aug 12, 2020
@xylar
Copy link
Collaborator Author

xylar commented Aug 12, 2020

I also just added documentation for the ISOMIP+ test cases more generally. This is not for LANL IC, but rather it's intended to be a bit more general. It's far from perfect but just needed to get something up there. I'll move on to other needed docs and come back to this if and when it's needed.

@xylar
Copy link
Collaborator Author

xylar commented Aug 12, 2020

I did a local test build of the docs on my laptop and everything looked right (at a quick glance). I think it should build okay once we merge.

@mark-petersen
Copy link
Contributor

@xylar and @cbegeman Thanks for working on the documentation. Will merge in a bit...

@mark-petersen mark-petersen merged commit fb8b7dd into MPAS-Dev:ocean/develop Aug 17, 2020
mark-petersen added a commit that referenced this pull request Aug 17, 2020
* ocean/develop:
  Move load_compass_env.sh to the ocean dir #618
  Update ISOMIP+ docs, including tutorial for Ocean0 on LANL IC #653
  Fix path to docs in Travis CI #644
  New Mesh: WC14to60kmL60E3SMv2r03 #628
jonbob added a commit to E3SM-Project/E3SM that referenced this pull request Aug 18, 2020
Update MPAS-Source: COMPASS and Documentation files

This PRi brings in a new mpas-source submdoule with changes only to the ocean
core. It updates files unrelated to the E3SM forward model, including:
* Move load_compass_env.sh to the ocean dir  (MPAS-Dev/MPAS-Model#618);
* Update ISOMIP+ docs, including tutorial for Ocean0 on LANL IC
  (MPAS-Dev/MPAS-Model#653);
* Fix path to docs in Travis CI  (MPAS-Dev/MPAS-Model#644);
* atmosphere core init changes  (MPAS-Dev/MPAS-Model#637);
* New Mesh: WC14to60kmL60E3SMv2r03  (MPAS-Dev/MPAS-Model#628);
* Fix ISOMIP+ viz scripts  (MPAS-Dev/MPAS-Model#642);
* Add support for custom critical passages and land blockages
  (MPAS-Dev/MPAS-Model#586); and
* New Mesh: WC12to60kmL60E3SMv2r01  (MPAS-Dev/MPAS-Model#555)

[BFB]
jonbob added a commit to E3SM-Project/E3SM that referenced this pull request Aug 19, 2020
Update MPAS-Source: COMPASS and Documentation files

This PR brings in a new mpas-source submdoule with changes only to the ocean
core. It updates files unrelated to the E3SM forward model, including:
* Move load_compass_env.sh to the ocean dir  (MPAS-Dev/MPAS-Model#618);
* Update ISOMIP+ docs, including tutorial for Ocean0 on LANL IC
  (MPAS-Dev/MPAS-Model#653);
* Fix path to docs in Travis CI  (MPAS-Dev/MPAS-Model#644);
* atmosphere core init changes  (MPAS-Dev/MPAS-Model#637);
* New Mesh: WC14to60kmL60E3SMv2r03  (MPAS-Dev/MPAS-Model#628);
* Fix ISOMIP+ viz scripts  (MPAS-Dev/MPAS-Model#642);
* Add support for custom critical passages and land blockages
  (MPAS-Dev/MPAS-Model#586); and
* New Mesh: WC12to60kmL60E3SMv2r01  (MPAS-Dev/MPAS-Model#555)

[BFB]
@xylar xylar deleted the compass_docs_isomip_plus branch August 21, 2020 11:40
caozd999 pushed a commit to caozd999/MPAS-Model that referenced this pull request Jan 14, 2021
…elop

Update ISOMIP+ docs, including tutorial for Ocean0 on LANL IC MPAS-Dev#653

This is updated in the documentation, rather than in the local README.

This merge also removes the README in ISOMIP+ COMPASS directory because
it is now redundant (and out of date).
@matthewhoffman matthewhoffman added COMPASS Documentation only Changes that impact code comments and documentation, but no executable code Ocean labels Mar 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COMPASS Documentation only Changes that impact code comments and documentation, but no executable code Ocean
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants