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

Updated RDA addresses and dataset names #790

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated RDA addresses and dataset names #790

wants to merge 1 commit into from

Conversation

kdraeder
Copy link
Contributor

@kdraeder kdraeder commented Jan 8, 2025

Description:

NCAR's Research Data Archive changed their dataset naming convention,
so all the references in DART became outdated.
The "local" (/glade) versions were also moved to a new location (/glade/campaign) when derecho replaced cheyenne.

Did not update
./CHANGELOG.rst
./_build/html/CHANGELOG.html
./_build/html/_sources/CHANGELOG.rst.txt

These substitutions were made:
sed \
-e "s#glade/collections#glade/campaign/collections#" \
-e "s#edu/ds/#edu/datasets/ds#g" \
-e "s#ds345.0#d345000#g" \
-e "s#ds199.1#d199001#g" \
-e "s#ds090.0#d090000#g" \
-e "s#ds337.0#d337000#g" \
-e "s#ds285.0#d285000#g" \

@hkershaw-brown I updated some .html files too, and would like confirmation that that was
the right thing to do.

@braczka Please check some of the CLM files, but I think that you don't need check all of them.

I did not add DOIs for these datasets, which would be more robust, but more work.

Fixes issue

#755

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

I checked the changes in
./models/POP/shell_scripts/cesm2_1/user_datm.streams.txt.CPLHISTForcing.Solar_template

I did not test any of the testable files.

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

Did not update
   ./CHANGELOG.rst
   ./_build/html/CHANGELOG.html
   ./_build/html/_sources/CHANGELOG.rst.txt

These substitutions were made:
sed \
    -e "s#glade\/collections#glade\/campaign\/collections#" \
    -e "s#edu\/ds\/#edu\/datasets\/ds#g" \
    -e "s#ds345.0#d345000#g" \
    -e "s#ds199.1#d199001#g" \
    -e "s#ds090.0#d090000#g" \
    -e "s#ds337.0#d337000#g" \
    -e "s#ds285.0#d285000#g" \
@kdraeder kdraeder added Bug Something isn't working Documentation Improvements or additions to documentation CAM Community Atmosphere Model CLM Community Land Model wrf Weather Research & Forecasting Model POP Parallel Ocean Program cice Sea Ice models labels Jan 8, 2025
@kdraeder kdraeder self-assigned this Jan 8, 2025
@hkershaw-brown
Copy link
Member

@hkershaw-brown I updated some .html files too, and would like confirmation that that was
the right thing to do.

Does not look like any html files in this pull request. Do you mean the .rst files?

@kdraeder
Copy link
Contributor Author

kdraeder commented Jan 8, 2025

@hkershaw-brown I updated some .html files too, and would like confirmation that that was
the right thing to do.

Does not look like any html files in this pull request. Do you mean the .rst files?

Apparently the files in _build/html/... are not under git control. I'm guessing those are exclude intentionally.

@hkershaw-brown
Copy link
Member

Apparently the files in _build/html/... are not under git control. I'm guessing those are exclude intentionally.

Yes those are files from the local build of the documentation.

@hkershaw-brown
Copy link
Member

How about for the .rst having one reference file for all the data sets so they only need to be changes in one place (when the rda links change, or change to dois).

.. CAM6rean :: https://rda.ucar.edu/datasets/d345000/

.. CAM4rean :: https://rda.ucar.edu/datasets/whatever

.. NCEPrda :: https://rda.ucar.edu/datasets/blahblah

@kdraeder
Copy link
Contributor Author

kdraeder commented Jan 8, 2025

How about for the .rst having one reference file for all the data sets so they only need to be changes in one place (when the rda links change, or change to dois).

.. CAM6rean :: https://rda.ucar.edu/datasets/d345000/

.. CAM4rean :: https://rda.ucar.edu/datasets/whatever

.. NCEPrda :: https://rda.ucar.edu/datasets/blahblah

That would tidy some of the files nicely. But most of the files are stream files.
I'll work on it.

@hkershaw-brown
Copy link
Member

Add this to conf.py them you can have a guide/references.rst (or whatever you want to call it) included in every file. This means you can use CAM6rean_ anywhere in the docs.

 89 # include references
 90 with open(os.path.join(os.path.dirname(__file__), 'guide/references.rst')) as f:
 91     references_content = f.read()
 92 
 93 rst_prolog = references_content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working CAM Community Atmosphere Model cice Sea Ice models CLM Community Land Model Documentation Improvements or additions to documentation POP Parallel Ocean Program wrf Weather Research & Forecasting Model
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants