====== NORESM wiki ======

**IMPORTANT IMPORTANT**

THIS DOCUMENTATION IS CONTINUED HERE:
https://noresm-docs.readthedocs.io/en/latest/

**IMPORTANT IMPORTANT**


NorESM1 is the Norwegian Earth System model used for CMIP5. The model is based on the CCSM framework (http://en.wikipedia.org/wiki/Community_Climate_System_Model). However, NorESM has special features developed by Norwegian researchers. 

Main references are: 

GMD - Special issue
The Norwegian Earth System Model:
NorESM; basic development, validation, scientific analyses, and climate scenarios

http://www.geosci-model-dev.net/special_issue20.html

Bentsen, M., I. Bethke, J. B. Debernard, T. Iversen, A. Kirkevåg, Ø. Seland, H. Drange, C. Roelandt, I. A. Seierstad, C. Hoose, and J. E. Kristjansson (2013): The Norwegian Earth System Model, NorESM1-M. Part 1: Description and basic evaluation of the physical climate, Geosci. Model Dev., 6, 687-720, doi:10.5194/gmd-6-687-2013

Iversen, T., M. Bentsen, I. Bethke, J. B. Debernard, A. Kirkevåg, Ø. Seland, H. Drange, J. E. Kristjansson, I. Medhaug, M. Sand, and I. A. Seierstad (2013): The Norwegian Earth System Model, NorESM1-M – Part 2: Climate response and scenario projections, Geosci. Model Dev., 6, 389-415, doi:10.5194/gmd-6-389-2013

Kirkevåg, A., T. Iversen, Ø. Seland, C. Hoose, J. E. Kristjánsson, H. Struthers, A. M. L. Ekman, S. Ghan, J. Griesfeller, E. D. Nilsson, and M. Schulz (2013): Aerosol–climate interactions in the Norwegian Earth System Model – NorESM1-M, Geosci. Model Dev., 6, 207-244, doi:10.5194/gmd-6-207-2013

Tjiputra, J. F., C. Roelandt, M. Bentsen, D. M. Lawrence, T. Lorentzen, J. Schwinger, Ø. Seland, and C. Heinze (2013): Evaluation of the carbon cycle components in the Norwegian Earth System Model (NorESM), Geosci. Model Dev., 6, 301-325, doi:10.5194/gmd-6-301-2013

The next version of the model NorESM2 is built on a update version of the CCSM framework, CESM2. (http://www.cesm.ucar.edu/models/cesm2/) ; (https://en.wikipedia.org/wiki/Community_Earth_System_Model). Its aerosol module is based on OsloAero5.3 of NorESM1.2 / CAM5.3-Oslo, documented here:

Kirkevåg, A., A. Grini, D. Olivié, Ø. Seland, K. Alterskjær, M. Hummel, I. H. H. Karset, A. Lewinschal, X. Liu, R. Makkonen, I. Bethke, J. Griesfeller, M. Schulz, and T. Iversen (2018): A production-tagged aerosol module for Earth system models, OsloAero5.3 – extensions and updates for CAM5.3-Oslo,
Geosci. Model Dev., 11, 3945-3982, https://doi.org/10.5194/gmd-11-3945-2018


This wiki contains information shared between NorESM developers and users

===== Purpose of wiki =====

The purpose of the wiki is to provide a common place for NorESM users and developers to share information. What tools are you using? Which version should I run for what purpose? etc.

Any questions about the wiki content should be directed to [[mailto:oyvindse@met.no|oyvindse@met.no]]
===== Obtaining a version of the model =====

**NEW** The development version has been moved to git: Obtain a copy through <file> git clone https://githubUserName@github.com/metno/noresm.git  </file> You first need to be registered as a noresm user on github (see detailed info in [[NORESM:GitBestPractice]])

To obtain the current official version (i.e an old version used in CMIP5) : svn checkout https://svn.met.no/NorESM/noresm/branches/noresm-ver1-cmip5. If you are not a registered user, contact trond.iversen@met.no to get the proper authorization.

The main trunk (stable development verison) is at the "master" branch on github (including CAM 5.3). (see detailed info in [[NORESM:GitBestPractice]])

If you are on a normal ubuntu PC and want the source code, you might see that "svn checkout" complains about "gnome keyring". If you see this problem, the solution is here: http://askubuntu.com/questions/206604/svn-and-gnome-keyring


**Need access to other versions: Special access document**:  https://docs.google.com/a/met.no/document/d/1G1ezxtBhzDyNWwrKJYWmp8gn402bOWThe_6gN00PDMQ/edit?usp=sharing

===== Running / Configuring the model =====

[[NORESM:RunModel:Newbie]]

[[NORESM:RunModel:Advanced]]

[[NORESM:RunModel:AdvancedNorESM2]]

[[NORESM:RunModel:FluxesCrossingBoundaries]]

[[NORESM:RunModel:CMIP6 volcanic forcing]]

[[NORESM:RunModel:CMIP6emissionsOfShortLivedComponents]]

[[NORESM:RunModel:CMIP6greenhouseGasConcentrations]]

[[NORESM:RunModel:NorESM2 output]]      (New Oct 30'th 2018)
===== Develop the model =====

====Setting up at different machines ====
Most developers compile and run NorESM on hexagon (hexagon.bccs.uib.no). That machine uses the portland group fortran compiler. Most developers develop the code on that machine using "develop/compile/run/analyze print statments" on that machine. 

Some experiments have also been done with compiling running CAM on a normal Linux PC in order to use interactive debuggers. (see below)

[[NORESM:SettingUpCamOnLinuxPc]]

==== Issue tracker ====

Any development should ideally be agreed with the NorESM development team and be properly described in the issue tracker, see the link below

[[NORESM:UsingTheIssueTracker]]

If you have changed the model and want to merge your changes to the trunk, your model has to pass some tests:

==== Testing ====

[[NORESM:TestList]]

==== Version control best practices ====

**NEW**: After switching to git (13th november 2015) the svn-repository is read-only. Some advice on how to use the new git-repository are available her:  [[NORESM:GitBestPractice]]

Some guidelines for modifying NorESM’s subversion repository: [[NORESM:SvnBestPractice]]

How-to for setting up svn repositories on NorStore: [[NORESM:SvnNorstoreHowto]]

==== NorESM2 branches in active development  ====
  * https://github.com/metno/noresm/ : master (this is the trunk/master version)
  * https://github.com/metno/noresm/ : featureCAM5-OsloDevelopment_trunk2.0-6 (Main development branch for CAM-Oslo aerosol features)
  * https://github.com/metno/noresm/ : feature-classnuc-ice_featureCAM5-OsloDevelopment-2 (ice nucleation feature branch)
  * https://github.com/metno/noresm/ : featureNitrate_featureCAM5-OsloDevelopment-2/ (aerosol nitrate feature branch)

==== NorESM1 branches in active development ====
   * https://github.com/metno/noresm/ : noresm-ver1-cmip5/ (Original NorESM1-M CMIP5 version. Only technical updates)
   * https://github.com/metno/noresm/ : noresm-ver1_r112-r169/ (Further development from the CMIP5 version. Include EU-ACCESS project improvements)

You obtain the model code through checking it out. The command would be
<file>
git clone https://githubUserName@github.com/metno/noresm.git
</file>
<file>
git checkout -b aBranchName origin/aBranchName
</file>
This gives the code in your directory

==== Uncertain parameters in the aerosol model  ====

Developing the model also involves setting some uncertain numbers into the model. Not all of these are available from namelists. Go to the link below to understand where main uncertainties are.

[[NORESM:UncertainAerosolParameters]]
===== Analyze model results =====

[[NORESM:modeldiagnostics|General diagnostics page]]

Several tools are shared among NorESM users

  * Prepare atmospheric output on pressure surfaces (Need working netcdf libraries) {{NORESM:pressuresurfaces.tar.gz}}
  * [[NORESM:noresm2nc4mpi|NorESM output compression tool on hexagon]]
  * [[NORESM:noresm2nc4norstore|NorESM output compression tool on NorStore]]
  * [[NORESM:ModelDiagnostics|ESM Model including Aerosol Diagnostic Tools]]
  * [[NORESM:ESMValTool|Earth System Model eValuation Tool (ESMValTool)]]
===== Archive model results =====

Long-term archiving is normally done on NorStore's disk resources (e.g, in /projects/NS2345K/noresm/cases). 

To avoid loss of data, another copy should be placed on tape. For instructions, see [[NORESM:NorstoreTape|Norstore Tape]]  

Data that builds the basis of publications should be migrated to NorStore's Research Data Archive in order to guarantee preservation and also to offload the project area. For specific NorESM instructions, see [[NORESM:norstorearchive|Norstore Archive]] 

===== CMIP5 archive of NorESM results =====

[[NORESM:norstorearchive|Norstore Archive]] 
===== Share model results =====

Model output and derived data products can be shared via the Norwegian Earth System Grid data portal [[http://noresg.norstore.no|http://noresg.norstore.no]] (see [[NORESM:NorstoreESG]] for instructions).  

Some aerosol and cloud-relevant output for the development version of NorESM2 is available for those with MET Norway affiliation through VpN at /vol/fou/emep/People/alfk/CAM-Oslo-diagnostics/
===== Past and ongoing work =====

Several simulations have been performed with NorESM. A list of available simulations and runs can be found here. [[NORESM:ListOfRuns]]. The page also contains an overview of planned simulations. 
A fairly extensive description of the model and to some extent also the CMIP5 runs can be found at http://pcmdi9.llnl.gov/esgf-web-fe/

Choose one of the links. Search for NorESM1-M CMIP5 in the search fields. Choose the link model documentation

NorESM is also used in several projects: [[NORESM:Projects]]

===== Resources =====
  * {{:noresm:EVAannualMeeting2018_WP4_IngoBethke_20180831.pdf| EVA final meeting: CMOR-ization and ESGF publication of NorESM2 simulations - Ingo Bethke}}
  * {{:noresm:LiuWorkshopESGF2018_IngoBethke.pdf| NICEST workshop for ESGF at NSC: CMOR post-processing of NorESM CMIP5 & CMIP6 output - Ingo Bethke}}
  * {{:noresm:noresmvaltool20170510.pdf|ESMValTool setup for NorESM (10 May 2017) - Ingo Bethke}}
  * TaiESM CCliCS workshop in Taipei 2016 - Ingo Bethke ({{noresm:BethkeEtAl_CCliCS2016_v2.pptx|pptx}}, {{noresm:BethkeEtAl_CCliCS2016_v2.pdf|pdf}}) 
  * {{:noresm:HappiEVA_kickoff-meeting_Ingo.pdf|HappiEVA kick-off 2016 - Ingo Bethke}}
  * {{:noresm:NeICESMworkshop2015_IngoBethke.pdf|NeIC/Nordic ESM workshop 2015 - CMOR-izing of NorESM output by Ingo Bethke}} 
  * {{NORESM:Eva2014_IngoBethke.pdf|Presentation on data management in EVA - EVA meeting, 2014, Bergen}}
  * {{:noresm:alfg_stockholmpres.pdf|NorESM Workshop 2014 SU - Alf Grini}}
  * {{:noresm:annica_new_noresm_workshop_2014.pdf|NorESM Workshop 2014 SU - Annica Ekman}}
  * {{:noresm:workshop-14_chandan.pdf|NorESM Workshop 2014 SU - Chandan Basu}}
  * {{:noresm:pausata_noresm_2014.pdf|NorESM Workshop 2014 SU - Francesco Pausata}}
  * {{:noresm:pegasos_oct_acosta.pdf|NorESM Workshop 2014 SU - Juan-Camilo Acosta}}
  * {{:noresm:makkonen_noresm_ws_2014.pdf|NorESM Workshop 2014 SU - Risto Makkonen}}
  * {{:noresm:trondiversen_noresm-workshop_oct2014.pdf|NorESM Workshop 2014 SU - Trond Iversen}}
  * {{:noresm:vidya_noresm_ws_2014_su.pdf|NorESM Workshop 2014 SU - Vidya Varma}}
  * {{:noresm:AeroTab-slides.pdf|After NorESM Workshop 2014 SU - Alf Kirkevåg: some AeroTab-slides}}