Skip to content

feat: Add cutout schema version - #533

Open
euronion wants to merge 10 commits into
masterfrom
cutout-schema-version
Open

euronion wants to merge 10 commits into
masterfrom
cutout-schema-version

Conversation

@euronion

@euronion euronion commented Oct 9, 2026

Copy link
Copy Markdown
Collaborator

This PR adds a cutout data schema version to all cutouts created by atlite.
Having a cutout schema version allows us to define breaking changes between atlite versions for cutouts.
It also allows us to define a migration logic (if migration is possible).

Note: Migrating cutouts between versions does not guarantee that cutouts with the same schema version are identical - changes in processing by atlite as well as in upstream data can happen independently of the schema version.

The schema version is an integer value that is bumped whenever the schema changes.
Simple changes to the schema may be migrated, more complex changes may make different schema versions incompatible with each other.

Checklist

  • Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in doc.
  • Unit tests for new features were added (if applicable).
  • [n/a] Newly introduced dependencies are added to environment.yaml, environment_docs.yaml and setup.py (if applicable).
  • A note for the release notes doc/release_notes.rst of the upcoming release is included.
  • I consent to the release of this PR's code under the MIT license.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant