Skip to content

Commit

Permalink
update documentation in prep for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Hamman committed Dec 14, 2021
1 parent 95e0915 commit 7670905
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/Development/ModelDevelopment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

We encourage any users who have modified (or would like to modify) VIC, either to fix bugs or develop new features, to contact us and coordinate development work with us. The VIC model source code is archived in Git and is publicly available through [GitHub](https://github.com). To access the source code, visit [GitHub](https://github.com), create an account, and visit [github.com/UW-Hydro/VIC](https://github.com/UW-Hydro/VIC). The routing model will soon be added to the archive as well.

VIC is an [open source](open-source-philosophy.md) development model and is released under the terms of the [GNU General Public License v2 (GPL).](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
VIC is an [open source](open-source-philosophy.md) development model and is released under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Instructions for using Git and GitHub to access the VIC code and contribute changes are here:

Expand Down
13 changes: 8 additions & 5 deletions docs/Development/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@ To check which release of VIC you are running:

------------------------------

## VIC 5.1.0
## VIC 5.1.0 (December 14, 2021)

This is a maintanence release that includes numerous bug fixes and a few model enhancements. All code changes were included in the two release candidates (5.1.0.rc1 and 5.1.0.rc2). See the notes below from the two release candidates for more details.

#### Announcements

1. VIC is now shared under the MIT license ([GH#917](https://github.com/UW-Hydro/VIC/pull/917))
1. VIC is now shared under the MIT license ([GH#917](https://github.com/UW-Hydro/VIC/pull/917)).
2. Travis-CI was disabled folling the platform's migration to travis-ci.com. See [GH#919](https://github.com/UW-Hydro/VIC/issues/919) for more details ([GH918](https://github.com/UW-Hydro/VIC/pull/918)).

## VIC 5.1.0 rc2
## VIC 5.1.0 rc2 (September 28, 2020)

#### Bug Fixes:

Expand All @@ -31,11 +34,11 @@ To check which release of VIC you are running:

3. Removed descriptions of forcing disaggregation options from documentation of image driver global parameter file ([GH#833](https://github.com/UW-Hydro/VIC/pull/833))

4. Fixed segmentation fault in lake model caused by incorrect passing of pointer argument to vic_run(). ([GH#826]((https://github.com/UW-Hydro/VIC/pull/826))
4. Fixed segmentation fault in lake model caused by incorrect passing of pointer argument to `vic_run()`. ([GH#826]((https://github.com/UW-Hydro/VIC/pull/826))

5. Relaxed some of the validation of lake parameters, to allow them to be null in cells containing no lakes. ([GH#826]((https://github.com/UW-Hydro/VIC/pull/826))

6. Fixed passing of lake data structures to generate_default_lake_state(). ([GH#826]((https://github.com/UW-Hydro/VIC/pull/826))
6. Fixed passing of lake data structures to `generate_default_lake_state()`. ([GH#826]((https://github.com/UW-Hydro/VIC/pull/826))

7. Separated the dimensions of arrays related to lake basin shape and of arrays related to the number of lake simulation layers. ([GH#826]((https://github.com/UW-Hydro/VIC/pull/826))

Expand Down
9 changes: 0 additions & 9 deletions docs/Development/Testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,3 @@ The VIC test suite uses a set of Python utilities and libraries to execute the s
--classic=vic/drivers/classic/vic_classic.exe \
--data_dir=${SAMPLES_PATH}/data \
--examples=./tests/examples/examples.cfg

## Travis

VIC uses the [Travis CI](http://travis-ci.org/) continuous integration system. VIC's build tests on Travis test the compilation of the main VIC drivers using a range of environments:

- *Compilers*: `gcc` and `clang`
- *Platforms*: `Linux` and `OSX`

The Travis tests also run the **unit**, **system**, and **examples** tests described above.
2 changes: 1 addition & 1 deletion docs/Development/open-source-philosophy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VIC Model Open Source Philosophy

VIC is Open Source software. We have licensed the source code with the [GNU GPL v2.0 license](http://www.gnu.org/licenses/gpl-2.0.html). This license provides very few restrictions on use.
VIC is Open Source software. We have licensed the source code with the [MIT license](https://opensource.org/licenses/MIT). This license provides very few restrictions on use.

Our rationale for moving the VIC model development to the open source community is that we want:
- to encourage other researchers and developers to contribute to the VIC development, and
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Variable Infiltration Capacity (VIC) Macroscale Hydrologic Model

[![VIC Users Listserve](https://img.shields.io/badge/VIC%20Users%20Listserve-Active-blue.svg)](https://mailman.u.washington.edu/mailman/listinfo/vic_users) [![Join the chat at https://gitter.im/UW-Hydro/VIC](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/UW-Hydro/VIC?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub license](https://img.shields.io/badge/license-GPLv2-blue.svg)](https://raw.githubusercontent.com/UW-Hydro/VIC/master/LICENSE.txt) [![Documentation Status](https://readthedocs.org/projects/vic/badge/?version=latest)](http://vic.readthedocs.org/en/latest/)
[![VIC Users Listserve](https://img.shields.io/badge/VIC%20Users%20Listserve-Active-blue.svg)](https://mailman.u.washington.edu/mailman/listinfo/vic_users) [![Join the chat at https://gitter.im/UW-Hydro/VIC](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/UW-Hydro/VIC?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/UW-Hydro/VIC/master/LICENSE.txt) [![Documentation Status](https://readthedocs.org/projects/vic/badge/?version=latest)](http://vic.readthedocs.org/en/latest/)
[![DOI](https://zenodo.org/badge/7766/UW-Hydro/VIC.svg)](https://zenodo.org/badge/latestdoi/7766/UW-Hydro/VIC)

!!! note
You are viewing the documentation for VIC version 5 (VIC-5). Relative to VIC-4, this version includes many infrastructure improvements. Those enhancements are described in [Hamman et al, 2018](https://doi.org/10.5194/gmd-11-3481-2018).

VIC ([Liang et al., 1994](Documentation/References.md)) is a macroscale hydrologic model that solves full water and energy balances, originally developed by Xu Liang at the University of Washington. VIC is a research model and in its various forms it has been applied to most of the major river basins around the world, as well as [globally](links.md). The VIC model is distributed under the [GNU GPL v2.0](http://www.gnu.org/licenses/gpl-2.0.html) license. If you make use of this model, please acknowledge the appropriate references listed on the [references](Documentation/References.md) page. These should include [Liang et al., 1994](Documentation/References.md), [Hamman et al., 2018](Documentation/References.md) for VIC-5, and any references relevant to the features you are using, which are cited in the feature descriptions on the [Model Overview](Overview/ModelOverview.md) page.
VIC ([Liang et al., 1994](Documentation/References.md)) is a macroscale hydrologic model that solves full water and energy balances, originally developed by Xu Liang at the University of Washington. VIC is a research model and in its various forms it has been applied to most of the major river basins around the world, as well as [globally](links.md). The VIC model is distributed under the [MIT license](https://opensource.org/licenses/MIT). If you make use of this model, please acknowledge the appropriate references listed on the [references](Documentation/References.md) page. These should include [Liang et al., 1994](Documentation/References.md), [Hamman et al., 2018](Documentation/References.md) for VIC-5, and any references relevant to the features you are using, which are cited in the feature descriptions on the [Model Overview](Overview/ModelOverview.md) page.

Development and maintenance of the current official version of the VIC model is led by the [UW Hydro | Computational Hydrology group](http://uw-hydro.github.io/) in the [Department of Civil and Environmental Engineering](http://www.ce.washington.edu) at the [University of Washington](http://www.washington.edu). Every new application addresses new problems and conditions that the model may not currently be able to handle, and as such the model is always under development. The VIC model is an open source development project, which means that contributions are welcome, including to the VIC documentation.

Expand Down

0 comments on commit 7670905

Please sign in to comment.