Simplify cli and ops instructions #52
Conversation
There was a problem hiding this comment.
@mmacferrin here's the operations document:
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
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
Closes #5.containing "pre-commit.ci autofix")