Skip to content

Commit

Permalink
updated changelog, added cicd badges
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonKamuk committed May 31, 2024
1 parent 43558dc commit 3d77ac4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<!---
![Linting](https://github.com/mllam/neural-lam/actions/workflows/pre-commit.yml/badge.svg)
![Automatic tests](https://github.com/mllam/neural-lam/actions/workflows/run_tests.yml/badge.svg)
-->

<p align="middle">
<img src="figures/neural_lam_header.png" width="700">
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/create_reduced_meps_dataset.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
Expand Down

0 comments on commit 3d77ac4

Please sign in to comment.