diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ab9af09..e47878c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,12 +2,11 @@ All notable changes to this project will be documented in this file. We follow the [Semantic Versioning 2.0.0](http://semver.org/) format. -## Pre-Release 0.0.0 2020-09-14 +## x.y.z - YYYY-MM-DD ### Added -- Initial configuration management -- Initial calibration workflow (with many TODO's) +- Lorem ipsum dolor sit amet ### Deprecated diff --git a/README.md b/README.md index 03723a76..abcac5a1 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,19 @@ -# NGen Calibration -todo-remove-w-rebase -**Description**: Supporting code/workflows for automated calibration of [NGen](https://github.com/noaa-owp/ngen) Formulations using Dynamic Dimensioned Search (DDS) +## NextGen_Model_Calibration - - **Technology stack**: Python based workflow for generating [NGen](https://github.com/noaa-owp/ngen) parameter formulation permutations and running these through the [NGen](https://github.com/noaa-owp/ngen) framework driver. - - **Status**: This work is in pre-release development, for more details see the [CHANGELOG](CHANGELOG.md). + NextGen_Model_Calibration is a model-agnostic Python software supporting automatic calibration of a variety of NextGen formulations. -## Dependencies - -Unit testing done with [pytest](https://github.com/pytest-dev/pytest). See [requirements.txt](requirements.txt) for other specific python dependencies. - -## Installation - -`TODO` [INSTALL](INSTALL.md) document. - -## Configuration - -`TODO` +## Main Features +- Calibrates parameters for different NextGen model and model components such as Conceptual Functional Equivalent (CFE), TOPMODEL, Noah-OWP-Modular, Lumped Arid/Semi-arid Model (LASAM), soil freeze-thaw model (SFT) and soil moisture profile (SMP). +- Implements three parameter optimization algorithms, including dynamically dimensioned search (DDS), particle swarm optimization (PSO) and grey wolf optimizer (GWO). +- Provides interface to choose different objective functions such as KGE, NSE, RMSE, etc. +- Installs statistical and visualization tools to monitor and explore calibration and validation simulation performance. +## Overview of packages +- __createInput__: This subpackage generates the required input data and configuration files to perform calibation. +- __ngen.cal__: This subpackge calibrates NextGen formulations parameters using the specified calibration settings through BMI. It also implements functionalities to perform validation runs using the default and best parameter set, respectively. +- __ngen.config__: This subpackage parses and validates realization configurations of versatile NextGen model and model components. + ## Usage - -`TODO` - -## How to test the software - - -Install `pytest` and other python dependencies (`pip install -r python/requirements.txt`) -Or create a virtual environment: -``` -mkdir venv -virtualenv ./venv -source ./venv/bin/activate -pip install -r python/requirements.txt -``` -Then use `pytest` to run the tests: -`pytest --log-cli-level 0 python/ngen-cal/test/` -## Known issues -## Known issues - - -## Getting help - -If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker. - -## Getting involved - -See [CONTRIBUTING](CONTRIBUTING.md), or open an issue to start a conversation! ----- - -## Open source licensing info -1. [TERMS](TERMS.md) -2. [LICENSE](LICENSE) - - ----- + This calibration tool provides an easily operated interface to perform model parameter estimation. [User's Guide](https://github.com/NOAA-OWP/NextGen_Model_Calibration/tree/master/doc) in _doc_ folder describes +the instructions on installation, configuration and execution of calibration workflow in detail. This documentation also describes all the subpackages and scripts plus the required libraries and data. A shell script in _examples_ folder demonstrates the procedure to generate input for the specified basin and NextGen formulation, and execute calibration and validation runs using the functionalities in this tool. +