-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
47dd202
commit 3822f38
Showing
1 changed file
with
5 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
# CryoGrid Community Model | ||
# CryoGrid community model | ||
|
||
This is the community version of *CryoGrid*, a numerical model to investigate land surface processes in permafrost environments. This version of *CryoGrid* is implemented in MATLAB. | ||
This is the community version of *CryoGrid*, a numerical model to investigate land surface processes in the terrestrial cryosphere. This version of *CryoGrid* is implemented in MATLAB. | ||
|
||
*Note: This is the latest major version of the CryoGrid model family. It comprises the functionalities of previous versions including [CryoGrid3](https://github.com/CryoGrid/CryoGrid3), which we no longer encourage to be used.* | ||
*Note: This is the latest development of the CryoGrid model family. It comprises the functionalities of previous versions including [CryoGrid3](https://github.com/CryoGrid/CryoGrid3), which is no longer encouraged to be used.* | ||
|
||
## Documentation | ||
|
||
The documentation of *CryoGrid* is hosted on [ReadTheDocs](https://cryogrid-documentation.readthedocs.io/en/latest/). Some parts of the documentation have yet to be incorporated into ReadTheDocs and are currently provided in a separate [PDF](./doc/CryoGrid_documentation.pdf). | ||
A manuscript "The CryoGrid community model - a multi-physics toolbox for climate-driven simulations in the terrestrial cryosphere" has been submitted to the journal Geoscientific Model Development which contains a description of the model and instructions to run it (Supplements 1, 3). | ||
|
||
## Getting started | ||
|
||
In order to run *CryoGrid*, additional user-adjustable files need to be obtained from the repository [CryoGridExamples](https://github.com/CryoGrid/CryoGridExamples). See [this section](https://cryogrid-documentation.readthedocs.io/en/latest/source/Quick%20start.html#get-started-getting-code-and-examples-for-running-your-first-model) in the documentation for detailed instructions on how to set up the model code and how to run first simulations. | ||
Both CryoGridCommunity_source and [CryoGridCommunity_run](https://github.com/CryoGrid/CryoGridCommunity_run) are required. See [CryoGridCommunity_run](https://github.com/CryoGrid/CryoGridCommunity_run) for details. |