Skip to content

Commit

Permalink
prepare release v0.2.0 (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
leifdenby authored Aug 5, 2024
1 parent c9413a4 commit 89880c3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 18 deletions.
47 changes: 30 additions & 17 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [unreleased](https://github.com/mllam/mllam-data-prep/compare/v0.1.0...HEAD)
## [unreleased](https://github.com/mllam/mllam-data-prep/releases/tags/v0.2.0)

[All changes](https://github.com/mllam/mllam-data-prep/compare/v0.2.0...v0.1.0)

### Added

Expand All @@ -24,24 +26,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- split dataset creation and storage to zarr into separate functions `mllam_data_prep.create_dataset(...)` and `mllam_data_prep.create_dataset_zarr(...)` respectively ![\#7](https://github.com/mllam/mllam-data-prep/pull/7)
- split dataset creation and storage to zarr into separate functions
`mllam_data_prep.create_dataset(...)` and
`mllam_data_prep.create_dataset_zarr(...)` respectively
![\#7](https://github.com/mllam/mllam-data-prep/pull/7)

- changes to spec from v0.1.0:
- the `architecture` section has been renamed `output` to make it clearer that this section defines the
properties of the output of `mllam-data-prep`
- `sampling_dim` removed from `output` (previously `architecture`) section of spec, this is not needed to create the training data
- the variables (and their dimensions) of the output definition has been renamed from `architecture.input_variables` to `output.variables`
- coordinate value ranges for the dimensions of the output (i.e. what that the architecture expects as input) has been renamed from
`architecture.input_ranges` to `output.coord_ranges` to make the use more clear
- selection on variable coordinates values is now set with `inputs.{dataset_name}.variables.{variable_name}.values`
rather than `inputs.{dataset_name}.variables.{variable_name}.sel`
- when dimension-mapping method `stack_variables_by_var_name` is used the formatting string for the new variable
is now called `name_format` rather than `name`
- when dimension-mapping is done by simply renaming a dimension this configuration now needs to be set by providing
the named method (`rename`) explicitly through the `method` key, i.e. rather than `{to_dim}: {from_dim}` it is now
`{to_dim}: {method: rename, dim: {from_dim}}` to match the signature of the other dimension-mapping methods.
- attribute `inputs.{dataset_name}.name` attribute has been removed, with the key `dataset_name` this is
superfluous
- the `architecture` section has been renamed `output` to make it clearer
that this section defines the properties of the output of `mllam-data-prep`
- `sampling_dim` removed from `output` (previously `architecture`) section of
spec, this is not needed to create the training data
- the variables (and their dimensions) of the output definition has been
renamed from `architecture.input_variables` to `output.variables`
- coordinate value ranges for the dimensions of the output (i.e. what that
the architecture expects as input) has been renamed from
`architecture.input_ranges` to `output.coord_ranges` to make the use more
clear
- selection on variable coordinates values is now set with
`inputs.{dataset_name}.variables.{variable_name}.values` rather than
`inputs.{dataset_name}.variables.{variable_name}.sel`
- when dimension-mapping method `stack_variables_by_var_name` is used the
formatting string for the new variable is now called `name_format` rather
than `name`
- when dimension-mapping is done by simply renaming a dimension this
configuration now needs to be set by providing the named method (`rename`)
explicitly through the `method` key, i.e. rather than `{to_dim}:
{from_dim}` it is now `{to_dim}: {method: rename, dim: {from_dim}}` to
match the signature of the other dimension-mapping methods.
- attribute `inputs.{dataset_name}.name` attribute has been removed, with the
key `dataset_name` this is superfluous

- relax minimuim python version requirement to `>3.8` to simplify downstream
usage ![\#13](https://github.com/mllam/mllam-data-prep/pull/13)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "mllam-data-prep"
version = "0.1.0"
version = "0.2.0"
description = "dataset preparation for data-driven weather models"
authors = [
{name = "Leif Denby", email = "[email protected]"},
Expand Down

0 comments on commit 89880c3

Please sign in to comment.