Skip to content

Commit 3efea4a

Browse files
authored
Merge pull request #5 from GEOS-ESM/rreichle/documentation/initial
initial documentation (CHANGELOG.md, README.md)
2 parents 5ea4eb5 + ef4da49 commit 3efea4a

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
1-
# Changelog
1+
# Changelog for `GEOSldas_GridComp`
22

33
All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
-----------------------------
9+
810
## [Unreleased]
911

12+
-----------------------------
13+
14+
## [v1.0.0] - 2024-03-26
15+
16+
- Inaugural version. 0-diff vs. GEOSldas v18.0.0.
17+
18+
-----------------------------
19+
1020
### Added
1121

1222
### Changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# GEOSldas_GridComp
2+
3+
The `GEOSldas_GridComp` repository contains the source code for the GEOS land modeling and data assimilation system (`GEOSldas`).
4+
5+
6+
## History
7+
8+
The repository was created in March 2024 by extracting the GEOSldas source code from the [`GEOSldas` fixture](https://github.com/GEOS-ESM/GEOSldas).
9+
10+
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).
11+
12+
13+
## Contributing
14+
15+
Please check out our [contributing guidelines](CONTRIBUTING.md).
16+
17+
## License
18+
19+
All files are currently licensed under the [Apache-2.0 license (`LICENSE`)](LICENSE).
20+
21+
Previously, the code was licensed under the [NASA Open Source Agreement, Version 1.3 (`LICENSE-NOSA`)](LICENSE-NOSA).

0 commit comments

Comments
 (0)