From 3d77ac4379ff4d34c560379397b5726e0c5f1edb Mon Sep 17 00:00:00 2001 From: Simon Kamuk Christiansen Date: Fri, 31 May 2024 09:20:31 +0200 Subject: [PATCH] updated changelog, added cicd badges --- CHANGELOG.md | 1 + README.md | 8 ++++++++ docs/notebooks/create_reduced_meps_dataset.ipynb | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 061aa6bb..6ec00858 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [unreleased](https://github.com/joeloskarsson/neural-lam/compare/v0.1.0...HEAD) ### 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 [/#38](https://github.com/mllam/neural-lam/pull/38) @SimonKamuk - Replaced `constants.py` with `data_config.yaml` for data configuration management [\#31](https://github.com/joeloskarsson/neural-lam/pull/31) diff --git a/README.md b/README.md index f16c940a..bd0d901f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ +![Linting](https://github.com/SimonKamuk/neural-lam/actions/workflows/pre-commit.yml/badge.svg?branch=feature_add_tests) +![Automatic tests](https://github.com/SimonKamuk/neural-lam/actions/workflows/run_tests.yml/badge.svg?branch=feature_add_tests) + + +

diff --git a/docs/notebooks/create_reduced_meps_dataset.ipynb b/docs/notebooks/create_reduced_meps_dataset.ipynb index 484f56a1..daba23c4 100644 --- a/docs/notebooks/create_reduced_meps_dataset.ipynb +++ b/docs/notebooks/create_reduced_meps_dataset.ipynb @@ -5,7 +5,7 @@ "metadata": {}, "source": [ "# Creating meps_example_reduced\n", - "This notebook outlines how the small-size test dataset meps_example_reduced was created based on the slightly larger dataset meps_example. The zipped up datasets are 263 MB and 2.6 GB, respectively.\n", + "This notebook outlines how the small-size test dataset ```meps_example_reduced``` was created based on the slightly larger dataset ```meps_example```. The zipped up datasets are 263 MB and 2.6 GB, respectively. See [README.md](../../README.md) for info on how to download ```meps_example```.\n", "\n", "The dataset was reduced in size by reducing the number of grid points and variables.\n" ]