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

Simplify cli and ops instructions #52

Merged
merged 1 commit into from
Jul 24, 2024
Merged

Conversation

mfisher87
Copy link
Contributor

@mfisher87 mfisher87 commented Jul 24, 2024

Now CLI looks like:

$ docker compose run cli --help
Usage: antarctica_today [OPTIONS] COMMAND [ARGS]...

  Antarctica Today.

Options:
  --help  Show this message and exit.

Commands:
  all-plots               Generate all Antarctica Today plot images from...
  daily-update-and-plots  Perform a daily update of the Antarctica Today...
  init                    Initialize the Antarctica Today database.

$ docker compose run cli init --help
Usage: antarctica_today init [OPTIONS] COMMAND [ARGS]...

  Initialize the Antarctica Today database.

Options:
  --help  Show this message and exit.

Commands:
  01-download-tb          Download NSIDC-0080 brightness temperature...
  02-generate-daily-melt  Generate daily melt files from brightness...
  03-preprocess           Perform pre-processing steps for Antarctica...
  all                     Initialize the Antarctica Today database.
PR checklist
  • Has a descriptive title
  • Has a descriptive body
  • Includes a link to any issues closed by this PR, e.g. Closes #5.
  • Passes checks (to auto-fix a pre-commit.ci failure, add a comment
    containing "pre-commit.ci autofix")

@mfisher87 mfisher87 changed the base branch from main to v2 July 24, 2024 20:20
@mfisher87 mfisher87 requested a review from mmacferrin July 24, 2024 20:28
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mmacferrin here's the operations document:

https://github.com/nsidc/Antarctica_Today/blob/088ec2556971680531af3181b40dbffb82c7cb63/doc/operation.md

The new "Quick start" section is how we will operate the code in production.

A specific place that could use your attention is the comment (in a collapsed "TODO" under step 2) is the UserWarning I receive: UserWarning: Warning: At least one NSIDC Tb file on date '20230909' is missing. Skipping that date. Is this expected? I'd like to document it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hi @mfisher87, that one is a bit confusing for me, as (1) the software should be able to gap-fill any missing data (that's what the gap-filling operation does), and (2) 20230909 (Sept 9, 2023) isn't even within the Antarctica Today defined melt season anyway (Oct 1 - April 30), so it shouldn't even matter if that date was missing. I believe you can delete that warning if you want.

Copy link
Contributor Author

@mfisher87 mfisher87 Jul 25, 2024

Choose a reason for hiding this comment

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

OK great, I set this warning up to only warn if the file is missing and the date is within the melt period :)

Thanks, Mike!

@mfisher87 mfisher87 merged commit 22a1fa1 into v2 Jul 24, 2024
3 checks passed
@mfisher87 mfisher87 deleted the simplify-cli-and-ops-instructions branch July 24, 2024 20:40
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.

2 participants