Skip to content

NorESMhub/NorESM-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Norwegian Earth System Model Documentation

License: GNU LGPL 3.0 NordicESMhub chat

The NorESM documentation on Read the Docs is built from the branches in this repository. The branches correspond to different versions of the NorESM source code.

version build status note
NorESM1 NorESM1 Documentation Status Model version used for CMIP5 and IPCC AR5
NorESM2 NorESM2 Documentation Status Model version used for CMIP6 and IPCC AR6
NorESM2.1 NorESM2.1 Documentation Status bugfix and technical release version
NorESM2.2 NorESM2.2 Documentation Status unvalidated development version
NorESM2.3 NorESM2.3 Documentation Status unvalidated development version : NorESM2.1 + FORCeS + KeyCLIM
NorESM2.5 NorESM2.5 Documentation Status development version : pre-NorESM3

How to contribute to the NorESM documentation

  • step 1: Fork this repository as shown in the figure below.

Fork NorESM documentation repository

  • step 2: Go online to NorESM documentation and whenever you would like to update the documentation, click on "Edit on GitHub".

Edit documentation online

  • step 3: Then click on the "pen" (see image below) and write your text (reStructuredText)

Edit the file in your fork

  • step 4: Save your changes in your forked repository and create a pull request.

Propose your changes

If you do not like to update the documentation online and prefer to use your favorite editor locally on your machine/laptop, you can skip step-3 and 4 and then clone your forked repository to edit the files locally. Once pushed to your forked github repository, you can create a pull request and propose your changes.

Example on how to see your changes locally with sphinx:

Prepare your PC/MAC

$ conda install sphinx
$ conda install -c conda-forge sphinxcontrib-bibtex
$ conda install -c conda-forge sphinx_rtd_theme

Copy NorESMdoc repository to local

$ git clone [email protected]:NorESMhub/NorESM-docs.git

go to NorESM-docs dir

$ sphinx-build . _build

open _build/index.html in browser

More info See https://coderefinery.github.io/documentation/sphinx/

About

Documentation of the NorESM model system and components

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages