Skip to content

What's new in v1.0.0

Upgrading from 0.x?

Stores written with canVODpy 0.x must be migrated before a v1.0.0 run writes to them. Upgrading to v1.0.0 has the commands, the changed settings and what is deprecated.

  •   A complete command line

    • canvodpy run, vod and vod-reconcile process data and compute VOD
    • canvodpy config creates, checks, shows and explains the settings
    • canvodpy store lists, inspects, maintains, migrates and amends stores
    • canvodpy stac, doctor and dashboard

    Command line

  •   Runs

    • One site per run; --update-to-latest for scheduled runs
    • A memory budget sizes the workers and the units of days a run commits at once; the next unit is read while VOD is computed
    • Each file's day comes from its name, in any folder layout
    • Warnings about files a run doesn't process and incomplete receiver-days
    • Airflow tasks run the same code as canvodpy run

    Command line and Python

  •   Stores

    • Day blocks: processing a day again writes only into that day's slots; no other day is touched
    • Content settings fixed when a store is created; runs with other settings are refused
    • Compare two stores within fixed tolerances
    • Migrate the stores of a 0.x site with one command
    • Stores on S3 (experimental)

    Storage

  •   Metadata and catalogs

    • Store metadata after DataCite and ACDD, checked against the standards
    • A STAC catalog of all stores; releases tag every store
    • Amend a store's description, with a reason
    • record_machine: false keeps the computer out of published stores

    Store metadata

  •   Settings

    • Settings and naming recipes from a GitHub link
    • canvodpy config init --from-store writes the settings of a store
    • canvodpy config validate also checks the receiver data
    • canvodpy config explain says what a setting means
    • Preprocessing is applied when set, and recorded in the store

    Configuration

  •   Run history and dashboard

    • Every run records itself, its stage timings and its resource use
    • A dashboard shows each run, the sites, and compares runs

    Diagnostics

  •   Extending canVODpy

    • Your own readers and VOD calculators, from installed packages
    • Interactive hemisphere selectors for notebooks
    • A public mapping between RINEX observation codes and signal IDs

    Plugins

  •   Demo data

    • canvodpy.demo_data() downloads the demo day, or its stores, checked by sha256
    • Notebooks that run in the browser

    Notebooks

The full list is in Upgrading to v1.0.0 and the changelog.