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 UMM-Var documentation following OB DAAC feedback. #19

Merged
merged 1 commit into from
Mar 15, 2024

Conversation

owenlittlejohns
Copy link
Member

Description

This PR updates the documentation for the notebook detailing the publication of UMM-Var records. The main aim of this PR is to make it clearer when it is preferable to use each of the workflows. There are no significant code changes.

Jira Issue ID

N/A

Local Test Steps

Proofread the notebook to check it makes sense.

PR Acceptance Checklist

  • Jira ticket acceptance criteria met.
  • CHANGELOG.md updated to include high level summary of PR changes.
  • VERSION updated if publishing a release.
  • Tests added/updated and passing.
  • Documentation updated (if needed).

"from cmr import CMR_UAT\n",
"\n",
"from varinfo import VarInfoFromNetCDF4\n",
"from varinfo.umm_var import get_umm_var, publish_umm_var"
Copy link
Member Author

Choose a reason for hiding this comment

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

I made a minor tweak to the code here to include the imports and instantiation of the VarInfoFromNetCDF4 object just so the workflow didn't depend on anything outside of this section of the notebook.

"from varinfo.umm_var import (get_all_umm_var, get_umm_var, publish_all_umm_var,\n",
" publish_umm_var)"
"from varinfo.cmr_search import download_granule, get_granules, get_granule_link\n",
"from varinfo.umm_var import get_all_umm_var, publish_all_umm_var, publish_umm_var"
Copy link
Member Author

Choose a reason for hiding this comment

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

These changes just strip out the stuff that is only used in workflow 3 (single UMM-Var record), as those are now imported there, so each workflow is self-contained.

Copy link
Member

@flamingbear flamingbear left a comment

Choose a reason for hiding this comment

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

words make sense. I don't have a token to run through it, but the functional changes are minimal.

Copy link
Collaborator

@eni-awowale eni-awowale left a comment

Choose a reason for hiding this comment

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

Nice! I ran it after digging up Launchpad token and it works!

@owenlittlejohns owenlittlejohns merged commit a1d7630 into main Mar 15, 2024
5 checks passed
@owenlittlejohns owenlittlejohns deleted the update-docs-for-OBDAAC branch March 15, 2024 20:35
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.

3 participants