Difference between revisions of "ACCESS-ESM 1.5"

(Mid-Holocene: Change location of UM executable)
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Temporary page while I'm getting familiar with ACCESS-ESM 1.5.
+
{{Needs Update|Needs update for Gadi}}
 +
{{Stub}}
 +
This page describes the different configurations of ACCESS-ESM 1.5 currently available and how to access them.  
  
Will be converted into a documentation later on.
+
ESM stands for Earth System Model. ACCESS-ESM is a coupled model with the following components:
  
=Getting ACCESS-ESM1.5=
+
{| class="wikitable"
 +
|-
 +
! Submodel !! Model !! Version !! Notes
 +
|-
 +
| Atmosphere || [[UM]] || 7.3 ||
 +
|-
 +
| Land Surface || [[CABLE]] || Part of UM ||
 +
|-
 +
| Sea Ice || CICE || ||
 +
|-
 +
| Ocean || [[MOM]] || 5 ||
 +
|-
 +
| Coupler || OASIS-MCT || 3 ||
 +
|}
  
There is some documentation on google drive, CMS > Coupled Models
+
__TOC__
  
<syntaxhighlight>
+
= Payu Experiments =
git clone git@bitbucket.org:climate-cms/csiro-scripts.git
 
cd csiro-scripts/original/build
 
make
 
</syntaxhighlight>
 
  
Turns out I needed access to the CABLE repo, see https://trac.nci.org.au/trac/cable/wiki/CableRegistration
+
We strongly recommend that you run ACCESS-ESM 1.5 using the payu driver. CSIRO is running the CMIP6 submission runs using a setup based on KSH scripts. The CMS team is working to adapt those configurations to payu.  
  
Other than that, compile worked fine.
+
Please contact [mailto:cws_help@nci.org.au the CMS team] if you would like a configuration that isn't currently available in payu or if you have any problems running a ACCESS-ESM 1.5 simulation with payu.
  
===Running first test===  
+
== piControl ==
 +
You can download the configuration by typing
 +
<syntaxhighlight lang="bash">$ git clone https://github.com/coecms/esm-pre-industrial.git
 +
</syntaxhighlight>
  
copy the scripts <span style="font-family:monospace">PI-C2C-1p5r29*}} from the {{original</span> directory to a new experiment directory.
+
[https://github.com/coecms/esm-pre-industrial The website] of the configuration also contains detailed instructions on how to run the model.
  
Rename the scripts with
+
Default configuration, based off CSIRO ksh scripts
  
<syntaxhighlight>
+
== PMIP4 Runs ==
rename PI-C2C-1p5r29 test1 PI-C2C-1p5r29*
+
Main Page:[[ACCESS-ESM-PMIP4|ACCESS-ESM-PMIP4]]
</syntaxhighlight>
 
  
Make sure that the correct project is set in <span style="font-family:monospace">test1</span>:
+
Currently contains two models from the PMIP4 setting: Last Interglacial and Mid-Holocene.
  
<syntaxhighlight>
+
Please refer to the main page to know where to download the configurations from.
#PBS -P w35
 
</syntaxhighlight>
 
  
Change initial date and final date in <span style="font-family:monospace">test1.init</span>:
+
=== ''Last Interglacial'' ===
 +
Science Contacts: Nick Yeung, Laurie Menviel
  
<syntaxhighlight>
+
Note: In addition to changed MMRs for certain gases, it also needs an updated UM build with different orbital parameters. This updated UM build is on gadi at
#-- Initial and Final Date of the Experiment
+
<syntaxhighlight lang="bash">/g/data/access/payu/access-esm-pmip/pmip-li/bin/um_hg3_20200706_pmip-li_r344.exe
iniyear=1;      finalyear=1;            typeset -Z4 iniyear  finalyear
 
inimonth=1;    finalmonth=1;          typeset -Z2 inimonth finalmonth
 
iniday=1;      finalday=5;            typeset -Z2 iniday  finalday
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Then run
+
=== ''Mid-Holocene'' ===
 
+
Science Contacts: Josephine Brown
<syntaxhighlight>
 
qsub test1
 
</syntaxhighlight>
 
 
 
Link the <span style="font-family:monospace">build</span> directory to the experiment directory.
 
 
 
====Issues====
 
 
 
The <span style="font-family:monospace">RUNID}} of {{PI-C2C-1p5r29}} was hardcoded in the script. I removed that hardcoded line and left the {{export RUNID=`basename $PBS_O_WORKDIR`</span> in because the experiment directory has the same name as the scripts.
 
 
 
It didn't find the build directory in the experiment directory. I linked the build directory there.
 
 
 
The model failed asking for a restart dump that didn't exist. Deleting the <span style="font-family:monospace">test1.date</span> file solved that.
 
 
 
Didn't find <span style="font-family:monospace">create_rankfile.py}} -- copied from {{original}} directory. (Had to delete {{test1.date</span> again.)
 
 
 
I also pre-emptively linked the <span style="font-family:monospace">runscripts}} directory from {{original</span> to my experiment directory.
 
 
 
==How ACCESS works==
 
 
 
===<RUNID>===  
 
 
 
The actual sumit script does not have an extension, and is a <span style="font-family:monospace">ksh</span> script.
 
It sets a whole lot of environment variables, most of them exported.
 
 
 
It then sources, if present, <span style="font-family:monospace">runscripts/umprofile}} which also sets some variables, however, many of these variables don't seem to refer to a path that exists on {{raijin</span>.
 
Then, again, if present, runs <span style="font-family:monospace">runscripts/setglobalvars</span>, again, the contents of which seem to be outdated.
 
 
 
It sets a few more variables, then sources <span style="font-family:monospace"><RUNID>.init</span>.
 
 
 
Many more variable declarations, then it sources <span style="font-family:monospace">UMScr_Toplevel</span>.
 
 
 
Finally, it sources <span style="font-family:monospace"><RUNID>.fin</span>
 
 
 
===<RUNID>.init===
 
 
 
This script is *sourced* by <span style="font-family:monospace"><RUNID></span>, so it's still a ksh script.
 
It begins with a function declaration, which sets certain ancillary files depending on the year.
 
 
 
Then come many more variables, including:
 
 
 
* <span style="font-family:monospace">CMIP5RUN}}, which can be any of these: {{picontrolv,historical,pi4xCO2,pi1pcntCO2,rcp45,rcp85,rcp26</span>.
 
* <span style="font-family:monospace">nproc_ice</span> (12 currently)
 
* <span style="font-family:monospace">oce_nx}} and {{oce_ny</span> for ocean decomposition (currently 12 and 4, respectively)
 
* <span style="font-family:monospace">ntproc}} as the total number of cores for this job ({{UM_NPES}} + {{nproc_ice}} + {{(oce_nx * oce_ny)</span>)
 
* <span style="font-family:monospace">iniyear}}, {{inimonth}}, and {{iniday}} as the initial date of the model, which is then compressed into {{inidate}} ({{YYYYMMDD</span>)
 
* <span style="font-family:monospace">finalyear}}, {{finalmonth}}, {{finalday}} as the final date of the model, compressed into {{finaldate</span>.
 
 
 
Then it looks for <span style="font-family:monospace"><RUNID>.date</span>:
 
 
 
If it '''doesn't''' exist, then it assumes that it's a new run. It creates the file and dumps the initial dates in there.
 
If the file '''does''' exist, it reads the date out of it (only last line).
 
 
 
It then uses <span style="font-family:monospace">~access/bin/calendar_more</span> to calculate the times for this run (initial date, end date, first date of next run, et cetera).
 
 
 
From this, it gets, amongst other things, the <span style="font-family:monospace">days_in_run}}, which it then multiplies by 86,400 (secs per day) to get {{runtime</span>.
 
 
 
Next, the script creates it work and run directories, copying files there as needed. (Apparently, for historical runs, it also needs to change the dates in the UM files, changing the reference date from the 16th of the month to the first.)
 
This is also where it uses the function it declared at the beginning.
 
 
 
Finally, it makes several (currently obscure) changes to a lot of namelists, and then creates the <span style="font-family:monospace">ACCESSRUNCMD</span>.
 
 
 
And it loads new modules, replacing others if they had been loaded before.
 
 
 
===<RUNID>.fin===
 
 
 
Check whether variable <span style="font-family:monospace">FCODE</span> is 0 (presumably the return code of the Model run?), only then will it do anything.
 
 
 
It calculates the name of the restart file <span style="font-family:monospace">restartfile="aiihca.da${umdate}"}} where {{umdate}} has been created by {{datetoum}} or {{datetoum2</span>.
 
 
 
Next, it moves what I think are the coupling restart files, <span style="font-family:monospace">${cplrundir}/?2?.nc}} to the archive {{${archivedir}/restart/cpl/$resfile-${enddate}</span>
 
 
 
Then, it accesses <span style="font-family:monospace">$atmrundir}}: Validates the date of the restart file, moves it to {{${archivedir}/restart/atm/${restartarch}}} (({{restartarch}} had been set to {{"${RUNID}.astart-${nextdate}"</span>).
 
 
 
Next, it moves all UM output files (<span style="font-family:monospace">aiihca.p*</span>) to the archive dir, renaming them in the process.
 
 
 
==Modifications==
 
 
 
Created a new branch: <span style="font-family:monospace">holger_testing</span>
 
 
 
===MOM5 Version Control===
 
 
 
MOM5 is under version control: <span style="font-family:monospace">https://github.com/OceansAus/ACCESS-ESM1.5-MOM5.git}} - this was added to the {{Makefile</span>.
 
 
 
===ummodel_hg3===
 
  
<span style="font-family:monospace">ummodel_hg3}} was still copied from {{/short/p66/txz599/ACCESSHOME/submodels/UM/ummodel_hg3/</span>. That directory itself is under version control, but with some non-checked-in.
+
Note: In addition to changed MMRs for certain trace gasses, it also needs and updated UM build with different orbital parameters. This updated UM build is at
 +
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><tt>/g/data/access/payu/access-esm-pmip/pmip-mh/bin/um_hg3_20200706_pmip-mh_r345.exe</tt></div>
  
===umbase_hg3===  
+
= CSIRO KSH Scripts =
  
<span style="font-family:monospace">umbase_hg3}} was still copied. But there weren't any interesting changes in the directory compared the the repository. (Only {{fcm_env.sh}} and {{parsed_bld.cfg</span>)
+
CSIRO is running the ACCESS-ESM model using ksh shell scripts. If you need to know, you can look [[ACCESS-ESM-CSIRO|here]].
So I've changed it to point to the svn repo.
 
  
===bld-hadgem3-mct.cfg===
 
  
The file <span style="font-family:monospace">bld-hadgem3-mct.cfg}} was missing from the {{ummodel_hg3}} repo. For now, I've made it part of the access-esm repo, and added a line in the {{Makefile</span> to copy it over.
 
  
  
[[Category: ACCESS]][[Category: Coupled Models]]
+
[[Category:ACCESS 1.5]] [[Category:Coupled Models]]

Revision as of 20:06, 7 January 2021

Template:Needs Update This page needs updating Needs update for Gadi
Template:Stub This is a stub page and needs expansion

This page describes the different configurations of ACCESS-ESM 1.5 currently available and how to access them.

ESM stands for Earth System Model. ACCESS-ESM is a coupled model with the following components:

Submodel Model Version Notes
Atmosphere UM 7.3
Land Surface CABLE Part of UM
Sea Ice CICE
Ocean MOM 5
Coupler OASIS-MCT 3

Payu Experiments

We strongly recommend that you run ACCESS-ESM 1.5 using the payu driver. CSIRO is running the CMIP6 submission runs using a setup based on KSH scripts. The CMS team is working to adapt those configurations to payu.

Please contact the CMS team if you would like a configuration that isn't currently available in payu or if you have any problems running a ACCESS-ESM 1.5 simulation with payu.

piControl

You can download the configuration by typing

$ git clone https://github.com/coecms/esm-pre-industrial.git

The website of the configuration also contains detailed instructions on how to run the model.

Default configuration, based off CSIRO ksh scripts

PMIP4 Runs

Main Page:ACCESS-ESM-PMIP4

Currently contains two models from the PMIP4 setting: Last Interglacial and Mid-Holocene.

Please refer to the main page to know where to download the configurations from.

Last Interglacial

Science Contacts: Nick Yeung, Laurie Menviel

Note: In addition to changed MMRs for certain gases, it also needs an updated UM build with different orbital parameters. This updated UM build is on gadi at

/g/data/access/payu/access-esm-pmip/pmip-li/bin/um_hg3_20200706_pmip-li_r344.exe

Mid-Holocene

Science Contacts: Josephine Brown

Note: In addition to changed MMRs for certain trace gasses, it also needs and updated UM build with different orbital parameters. This updated UM build is at

/g/data/access/payu/access-esm-pmip/pmip-mh/bin/um_hg3_20200706_pmip-mh_r345.exe

CSIRO KSH Scripts

CSIRO is running the ACCESS-ESM model using ksh shell scripts. If you need to know, you can look here.