From ef4da498b945ef710777cdeb89191ee60151943a Mon Sep 17 00:00:00 2001 From: Rolf Reichle Date: Tue, 26 Mar 2024 12:08:25 -0400 Subject: [PATCH] initial documentation (CHANGELOG.md, README.md) --- CHANGELOG.md | 12 +++++++++++- README.md | 20 ++++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index caab8cc..29d664c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,22 @@ -# Changelog +# Changelog for `GEOSldas_GridComp` 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.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +----------------------------- + ## [Unreleased] +----------------------------- + +## [v1.0.0] - 2024-03-26 + +- Inaugural version. 0-diff vs. GEOSldas v18.0.0. + +----------------------------- + ### Added ### Changed diff --git a/README.md b/README.md index ffe9bc4..1bcbcb8 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ # GEOSldas_GridComp + +The `GEOSldas_GridComp` repository contains the source code for the GEOS land modeling and data assimilation system (`GEOSldas`). + + +## History + +The repository was created in March 2024 by extracting the GEOSldas source code from the [`GEOSldas` fixture](https://github.com/GEOS-ESM/GEOSldas). + +The new repository was needed to facilitate the use of the `GEOSldas_GridComp` as an external repository in both the [`GEOSldas` fixture](https://github.com/GEOS-ESM/GEOSldas) and the [GEOS atmospheric data assimilation (`GEOSadas`) fixture](https://github.com/GEOS-ESM/GEOSadas). + + +## Contributing + +Please check out our [contributing guidelines](CONTRIBUTING.md). + +## License + +All files are currently licensed under the [Apache-2.0 license (`LICENSE`)](LICENSE). + +Previously, the code was licensed under the [NASA Open Source Agreement, Version 1.3 (`LICENSE-NOSA`)](LICENSE-NOSA).