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 POP docs regarding SourceMods and restarts in GDEX #765

Merged
merged 11 commits into from
Nov 8, 2024

Conversation

mjs2369
Copy link
Contributor

@mjs2369 mjs2369 commented Nov 5, 2024

Description:

Update POP docs to include discussion of SourceMods and where to get them and the availability of the initial restarts in the GDEX

Fixes issue

Fixes #476

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Built docs

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

@mjs2369
Copy link
Contributor Author

mjs2369 commented Nov 5, 2024

Do we think the documentation about LANL POP is still needed?

LANL POP
~~~~~~~~
In years subsequent to the initial development of the DART interface, the
Computer, Computational, and Statistical Sciences Division at LANL transitioned
from using POP as their primary ocean model to using the Model for Prediction
Across Scales-Ocean (MPAS-Ocean). Thus it became difficult for staff in the
Data Assimilation Research Section (DAReS) at NSF NCAR to maintain access to the
`LANL POP <https://climatemodeling.science.energy.gov/projects/climate-ocean-and-sea-ice-modeling-cosim>`_
source code. As a result, LANL POP has been tested using DART's Lanai framework
but has not been tested using DART's Manhattan framework. If you intend to use
LANL POP with DART Manhattan, contact DAReS staff for assistance by emailing
[email protected].

Copy link
Member

@hkershaw-brown hkershaw-brown left a comment

Choose a reason for hiding this comment

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

Nice work on getting the data on GDEX (Ben & Marlee)

I put a couple of definite changes in (keep Alicia's reference, remove the note about 'variable use_SourceMods').

Once Ben is happy with this, seems good to go.

models/POP/readme.rst Outdated Show resolved Hide resolved
models/POP/readme.rst Outdated Show resolved Hide resolved
@hkershaw-brown hkershaw-brown added the release+1 bundle with release after next label Nov 6, 2024
@mjs2369
Copy link
Contributor Author

mjs2369 commented Nov 6, 2024

Do we need DART/models/POP/README as well as the main readme.rst? There is some info about the broken test, test_dipole_interp, but mostly it is just development notes; see the comment below

DART/models/POP/README

Lines 72 to 75 in e218864

#----------------------------------------------------------------------
# Everything below here is just notes from the development process.
# It is highly unlikely it will mean anything to anyone but Tim H.
#----------------------------------------------------------------------

@hkershaw-brown
Copy link
Member

Do we need DART/models/POP/README as well as the main readme.rst? There is some info about the broken test, test_dipole_interp, but mostly it is just development notes; see the comment below

DART/models/POP/README

Lines 72 to 75 in e218864

#----------------------------------------------------------------------
# Everything below here is just notes from the development process.
# It is highly unlikely it will mean anything to anyone but Tim H.
#----------------------------------------------------------------------

Dunno, but it seems out of scope for adding the GDEX info to the docs.

@johnsonbk
Copy link
Collaborator

I think it's still in the scope of this pull request to git rm DART/models/POP/shell_scripts/cesm2_1/copy_POP_JRA_restarts.py since that script is now obsolete.

@mjs2369
Copy link
Contributor Author

mjs2369 commented Nov 7, 2024

I think it's still in the scope of this pull request to git rm DART/models/POP/shell_scripts/cesm2_1/copy_POP_JRA_restarts.py since that script is now obsolete.

Good idea @johnsonbk, I'll do that now

…cific directory on glade (ensemble now available on GDEX)
@hkershaw-brown hkershaw-brown added release! bundle with next release and removed release+1 bundle with release after next labels Nov 7, 2024
Copy link
Member

@hkershaw-brown hkershaw-brown 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 Marlee, great to have the data on GDEX.

@hkershaw-brown hkershaw-brown merged commit 55eaf62 into main Nov 8, 2024
4 checks passed
@hkershaw-brown hkershaw-brown deleted the pop_docs branch November 8, 2024 18:28
@johnsonbk
Copy link
Collaborator

Hooray!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release! bundle with next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: POP source mods for CESM2_1_1
3 participants