diff --git a/README.md b/README.md new file mode 100644 index 0000000000..3019f33162 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Branches in NorESMhub/CTSM + +This repository has the following CTSM branches intended to facilitate working with NorESM2: + +- **master** - keep track with the master branch of [ESCOMP/CTSM](https://github.com/ESCOMP/CTSM). + - This branch is used by [NorESMhub/NorESM_LandSites_Platform](https://github.com/NorESMhub/NorESM_LandSites_Platform) + - This branch can be used for running the most recent version of [FATES](https://github.com/NGEET/fates) + +- **release-clm5.0.14-Nor** - The working branch used by NorESM2. Non-answer changing (with respect to NorESM2s CMIP6 version) pull requests should be sent to this branch. For other changes, new branches discuss with CTSM and NorESM core teams. + - Tags in this branch help identifying the link to the NorESM2 releases: + - release-clm5.0.14-Nor_v1.0.2 - the tag working with NorESM2 noresm2 tags: release-noresm2.0.4, release-noresm2.0.3 + - release-clm5.0.14-Nor_v1.0.1 - the tag working with NorESM2 tags: release-noresm2.0.2 + - release-clm5.0.14-Nor_v1.0.0 - the tag working with NorESM2 tags: release-noresm2.0.1, release-noresm2.0.0 + +- **release-cesm2.2** - Copy of ESCOMP branch, base for release-cesm2.2.01-Nor branch. +- **release-cesm2.2.01-Nor** - The branch used for the next phase of NorESM2 (under development). + +- If you have problems with using this repository, please use [issue](https://github.com/NorESMhub/CTSM/issues) to send your questions. diff --git a/README.rst b/README.rst deleted file mode 100644 index 6569f5f809..0000000000 --- a/README.rst +++ /dev/null @@ -1,31 +0,0 @@ -==== -CTSM -==== - -The Community Terrestrial Systems Model. - -This includes the Community Land Model (CLM5.0 and CLM4.5) of the Community Earth System Model. - -For documentation, quick start, diagnostics, model output and -references, see - -http://www.cesm.ucar.edu/models/cesm2.0/land/ - -and - -https://escomp.github.io/ctsm-docs/ - -For help with how to work with CTSM in git, see - -https://github.com/ESCOMP/ctsm/wiki/Getting-started-with-CTSM-in-git - -and - -https://github.com/ESCOMP/ctsm/wiki/Recommended-git-setup - -To get updates on CTSM tags and important notes on CTSM developments -join our low traffic email list: - -https://groups.google.com/a/ucar.edu/forum/#!forum/ctsm-dev - -(Send email to ctsm-software@ucar.edu if you have problems with any of this)