prepare v0.3.0 release (#98)

CHANGELOG.md

@@ -5,7 +5,11 @@ 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/joeloskarsson/neural-lam/compare/v0.2.0...HEAD)
+## [unreleased](https://github.com/mllam/neural-lam/compare/v0.3.0...HEAD)
+
+## [v0.3.0](https://github.com/mllam/neural-lam/releases/tag/v0.3.0)
+
+This release introduces Datastores to represent input data from different sources (including zarr and numpy) while keeping graph generation within neural-lam.
 
 ### Added
 
@@ -19,27 +23,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Fix bugs introduced with datastores functionality relating visualation plots [\#91](https://github.com/mllam/neural-lam/pull/91) @leifdenby
 
-## [v0.2.0](https://github.com/joeloskarsson/neural-lam/releases/tag/v0.2.0)
+## [v0.2.0](https://github.com/mllam/neural-lam/releases/tag/v0.2.0)
 
 ### Added
 - Added tests for loading dataset, creating graph, and training model based on reduced MEPS dataset stored on AWS S3, along with automatic running of tests on push/PR to GitHub, including push to main branch. Added caching of test data to speed up running tests.
   [\#38](https://github.com/mllam/neural-lam/pull/38) [\#55](https://github.com/mllam/neural-lam/pull/55)
   @SimonKamuk
 
 - Replaced `constants.py` with `data_config.yaml` for data configuration management
-  [\#31](https://github.com/joeloskarsson/neural-lam/pull/31)
+  [\#31](https://github.com/mllam/neural-lam/pull/31)
   @sadamov
 
 - new metrics (`nll` and `crps_gauss`) and `metrics` submodule, stddiv output option
-  [c14b6b4](https://github.com/joeloskarsson/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
+  [c14b6b4](https://github.com/mllam/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
   @joeloskarsson
 
 - ability to "watch" metrics and log
-  [c14b6b4](https://github.com/joeloskarsson/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
+  [c14b6b4](https://github.com/mllam/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
   @joeloskarsson
 
 - pre-commit setup for linting and formatting
-  [\#6](https://github.com/joeloskarsson/neural-lam/pull/6), [\#8](https://github.com/joeloskarsson/neural-lam/pull/8)
+  [\#6](https://github.com/mllam/neural-lam/pull/6), [\#8](https://github.com/mllam/neural-lam/pull/8)
   @sadamov, @joeloskarsson
 
 - added github pull-request template to ease contribution and review process
@@ -66,31 +70,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   @sadamov
 
 - Updated scripts and modules to use `data_config.yaml` instead of `constants.py`
-  [\#31](https://github.com/joeloskarsson/neural-lam/pull/31)
+  [\#31](https://github.com/mllam/neural-lam/pull/31)
   @sadamov
 
 - Added new flags in `train_model.py` for configuration previously in `constants.py`
-  [\#31](https://github.com/joeloskarsson/neural-lam/pull/31)
+  [\#31](https://github.com/mllam/neural-lam/pull/31)
   @sadamov
 
 - moved batch-static features ("water cover") into forcing component return by `WeatherDataset`
-  [\#13](https://github.com/joeloskarsson/neural-lam/pull/13)
+  [\#13](https://github.com/mllam/neural-lam/pull/13)
   @joeloskarsson
 
 - change validation metric from `mae` to `rmse`
-  [c14b6b4](https://github.com/joeloskarsson/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
+  [c14b6b4](https://github.com/mllam/neural-lam/commit/c14b6b4323e6b56f1f18632b6ca8b0d65c3ce36a)
   @joeloskarsson
 
 - change RMSE definition to compute sqrt after all averaging
-  [\#10](https://github.com/joeloskarsson/neural-lam/pull/10)
+  [\#10](https://github.com/mllam/neural-lam/pull/10)
   @joeloskarsson
 
 ### Removed
 
 - `WeatherDataset(torch.Dataset)` no longer returns "batch-static" component of
   training item (only `prev_state`, `target_state` and `forcing`), the batch static features are
   instead included in forcing
-  [\#13](https://github.com/joeloskarsson/neural-lam/pull/13)
+  [\#13](https://github.com/mllam/neural-lam/pull/13)
   @joeloskarsson
 
 ### Maintenance
@@ -134,7 +138,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [\#78](https://github.com/mllam/neural-lam/pull/78)
   @joeloskarsson
 
-## [v0.1.0](https://github.com/joeloskarsson/neural-lam/releases/tag/v0.1.0)
+## [v0.1.0](https://github.com/mllam/neural-lam/releases/tag/v0.1.0)
 
 First tagged release of `neural-lam`, matching Oskarsson et al 2023 publication
 (<https://arxiv.org/abs/2309.17370>)

neural_lam/__init__.py

@@ -1,3 +1,6 @@
+# Standard library
+import importlib.metadata
+
 # First-party
 import neural_lam.interaction_net
 import neural_lam.metrics
@@ -7,3 +10,8 @@
 
 # Local
 from .weather_dataset import WeatherDataset
+
+try:
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"

pyproject.toml

@@ -1,11 +1,14 @@
 [project]
 name = "neural-lam"
-version = "0.2.0"
+version = "0.3.0"
 description = "LAM-based data-driven forecasting"
 authors = [
     { name = "Joel Oskarsson", email = "[email protected]" },
     { name = "Simon Adamov", email = "[email protected]" },
     { name = "Leif Denby", email = "[email protected]" },
+    { name = "Simon Kamuk Christiansen", email = "[email protected]" },
+    { name = "Kasper Hintz", email = "[email protected]" },
+    { name = "Erik Larsson", email = "[email protected]" },
 ]
 
 # PEP 621 project metadata

tests/test_imports.py

@@ -6,3 +6,4 @@
 def test_import():
     assert neural_lam is not None
     assert neural_lam.vis is not None
+    assert neural_lam.__version__ is not None