Version 2

.github/workflows/build-and-publish.yml

@@ -0,0 +1,26 @@
+name: "Build & publish artifacts"
+
+on:
+  push:
+    branches:
+      - "main"
+      - "v2"  # TODO: Remove before merge!
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+env:
+  # Many color libraries just need this to be set to any value, but at least
+  # one distinguishes color depth, where "3" -> "256-bit color".
+  FORCE_COLOR: 3
+
+jobs:
+  build-and-publish-docker-image:
+    name: "Build and publish Docker image"
+    uses: "nsidc/.github/.github/workflows/build-and-publish-container-image.yml@main"
+    with:
+      docker-image-name: "nsidc/antarctica_today"
+    secrets: "inherit"

.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: Continuous Integration
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Many color libraries just need this to be set to any value, but at least
+  # one distinguishes color depth, where "3" -> "256-bit color".
+  FORCE_COLOR: 3
+
+defaults:
+  run:
+    # Enables steps to see the micromamba environment:
+    shell: bash -leo pipefail {0}
+
+
+jobs:
+  checks:
+    name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8"]
+        runs-on:
+          - ubuntu-latest
+          - macos-latest
+          # - windows-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: mamba-org/setup-micromamba@v1
+        with:
+          micromamba-version: '1.5.6-0' # any version from https://github.com/mamba-org/micromamba-releases
+          environment-file: environment.yml
+          init-shell: >-
+            bash
+            powershell
+          cache-environment: true
+          post-cleanup: 'all'
+
+      - name: Type-check package
+        run: mypy
+
+      # - name: Test package
+      #   run: >-
+      #     python -m pytest -ra --cov --cov-report=xml --cov-report=term
+      #     --durations=20
+
+      # - name: Upload coverage report
+      #   uses: codecov/[email protected]
+      #   with:
+      #     token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,3 +1,6 @@
+# Compose
+compose.override.yml
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

Dockerfile

@@ -0,0 +1,26 @@
+FROM mambaorg/micromamba:1.5.8-alpine3.20
+
+WORKDIR /app
+
+# Activate the conda environment during build process
+ARG MAMBA_DOCKERFILE_ACTIVATE=1
+
+COPY ./conda-lock.yml .
+
+# NOTE: `-p` is important to install to the "base" env
+RUN micromamba install -y \
+    -p /opt/conda \
+    -f conda-lock.yml \
+  && micromamba clean --all --yes
+
+
+# Install source
+COPY ./pyproject.toml .
+COPY ./antarctica_today ./antarctica_today
+COPY ./qgis ./qgis
+
+# TODO: `pip install --editable .`
+ENV PYTHONPATH=.
+
+# Extend the default micromamba entrypoint to use our CLI
+ENTRYPOINT ["/usr/local/bin/_entrypoint.sh", "python", "antarctica_today"]

Tb/nsidc-0080/.gitignore

@@ -2,3 +2,5 @@
 *
 # Except this file
 !.gitignore
+*.nc
+*.bin

antarctica_today/__init__.py

@@ -0,0 +1,21 @@
+import os
+import sys
+
+# IMPORTANT: If we don't specify this setting, then the projection we want to use will
+# be replaced with another (and this warning will be printed)!
+#
+#   Warning 1: CRS EPSG:3411 is deprecated. Its non-deprecated replacement EPSG:3413 will be
+#   used instead. To use the original CRS, set the OSR_USE_NON_DEPRECATED configuration
+#   option to NO.
+#   Warning 1: CRS EPSG:3412 is deprecated. Its non-deprecated replacement EPSG:3976 will be
+#   used instead. To use the original CRS, set the OSR_USE_NON_DEPRECATED configuration
+#   option to NO.
+os.environ["OSR_USE_NON_DEPRECATED"] = "NO"
+
+
+# Ignore warnings by default, while still allowing users to change the behavior, e.g. by
+# upgrading them to exceptions.
+if not sys.warnoptions:
+    import warnings
+
+    warnings.simplefilter("ignore")

antarctica_today/__main__.py

@@ -0,0 +1,100 @@
+import click
+from loguru import logger
+
+from antarctica_today.generate_daily_melt_file import generate_new_daily_melt_files
+from antarctica_today.generate_gap_filled_melt_picklefile import (
+    save_gap_filled_picklefile,
+)
+from antarctica_today.main import (
+    generate_all_plots_and_maps_main,
+    preprocessing_main,
+)
+from antarctica_today.melt_array_picklefile import save_model_array_picklefile
+from antarctica_today.nsidc_download_Tb_data import download_new_files
+from antarctica_today.update_data import update_everything_to_latest_date
+
+
+@click.group()
+def cli():
+    """Antarctica Today."""
+    pass
+
+
+@cli.group()
+def init():
+    """Initialize the Antarctica Today database and generate all plots."""
+    pass
+
+
+@init.command("01-download-tb")
+def download_tb():
+    """Download NSIDC-0080 brightness temperature granules.
+
+    By default, data is downloaded starting on 2022-01-10, as data before then is
+    committed to this repository. This pre-generated data was generated from NSIDC-0001
+    and NSIDC-0007 datasets.
+    """
+    download_new_files()
+    logger.success("Download of NSIDC-0080 granules complete.")
+
+
+@init.command("02-generate-daily-melt")
+def generate_daily_melt():
+    """Generate daily melt files from brightness temperature granules.
+
+    These files are written as binary files with ".bin" extension in the
+    `/data/daily_melt_bin_files/` directory in this repository.
+    """
+    generate_new_daily_melt_files(overwrite=False)
+    logger.success("Generation of daily melt files complete.")
+
+
+@init.command("03-preprocess")
+def preprocess():
+    """Perform pre-processing steps for Antarctica Today data.
+
+    This includes CSV, TIF, and pickled numpy arrays with ".pickle" extension.
+    """
+    preprocessing_main()
+    logger.success("Preprocess complete.")
+
+
+@init.command("04-all-plots")
+def all_plots():
+    """Generate all Antarctica Today plot images from the database."""
+    generate_all_plots_and_maps_main()
+    logger.success("All plots generated.")
+
+
+@init.command("all")
+def init_all():
+    """Initialize the Antarctica Today database and generate all plots."""
+    download_new_files()
+    generate_new_daily_melt_files(overwrite=False)
+    preprocessing_main()
+    generate_all_plots_and_maps_main()
+    logger.success("Antarctica Today database initialized.")
+
+
+@cli.command()
+def daily_update_and_plots():
+    """Perform a daily update of the Antarctica Today database and produce plots.
+
+    This includes:
+
+    * A "daily melt" map of the most recent day's melt extent
+    * A "sum" map of the current season's total melt days
+    * An "anomaly" map of that season's total melt days in comparison to baseline
+      average values to-that-day-of-year
+    * A line plot of melt extent up do that date, compared to historical baseline
+      averages
+
+    It will copy these plots into a sub-directory `/plots/daily_plots_gathered/[date]/`
+    for easy collection.
+    """
+    update_everything_to_latest_date(copy_to_gathered_dir=True)
+    logger.success("Database updated to the current date. New plots produced.")
+
+
+if __name__ == "__main__":
+    cli()