# Updating ESM1.5 configurations for payu version \`1.1.5\`

**URL:** <https://forum.access-hive.org.au/t/updating-esm1-5-configurations-for-payu-version-1-1-5/3126>\
**Category:** Earth System Model\
**Tags:** tutorial, payu, how-to, access-esm15\
**Created:** [30 August 2024 05:20 UTC](https://forum.access-hive.org.au/t/updating-esm1-5-configurations-for-payu-version-1-1-5/3126 "2024-08-30T05:20:48Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![spencerwong](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/spencerwong/32/1894_2.png) [@spencerwong](https://forum.access-hive.org.au/u/spencerwong)\
**Post date:** [30 August 2024 05:20 UTC](https://forum.access-hive.org.au/t/updating-esm1-5-configurations-for-payu-version-1-1-5/3126/1 "2024-08-30T05:20:48Z")

</div>

[Payu version `1.1.5`](https://forum.access-hive.org.au/t/payu-a-workflow-manager-for-some-access-models/1098/6) updates the way ACCESS-ESM1.5 experiments are configured, coinciding with the [new release of the model.](https://forum.access-hive.org.au/t/access-esm1-5-release-information/2352)

Configurations cloned from the [ACCESS-NRI ESM1.5 configuration repository](https://github.com/ACCESS-NRI/access-esm1.5-configs) will work immediately with the newest version of payu. Older configurations should still work with the previous version of payu, which can be accessed on gadi via:

```bash
$ module use /g/data/vk83/modules
$ module load payu/1.1.3

```

To use the latest version of payu instead, the configuration can be updated with the following two changes:

### 1. `um_env.py` in the atmosphere control directory

Older ESM1.5 configurations will contain a python file `um_env.py` in the `<control-directory>/atmosphere` directory.

This file contains a dictionary of environment variables used by the UM during a simulation:

```python
um_env.py
-----------
vars = {
'AINITIAL': '',
'ASTART': 'INPUT/pre-industrial.astart', 
'AUSCOM_CPL': 'true',
'DATAW': '{work_path}',
'FASTRUN': 'true',
...

```

Due to security concerns, this has been replaced by a `yaml` file in the released configurations, which sets the same information:

```yaml
um_env.yaml
-----------
AINITIAL: ''
ASTART: INPUT/pre-industrial.astart
AUSCOM_CPL: 'true'
DATAW: '{work_path}'
FASTRUN: 'true'
...

```

To run older configurations with the new version of payu, the `um_env.py` file will need to be translated to a `um_env.yaml` file. A translation script `um_env_to_yaml.py` is available [here](https://github.com/ACCESS-NRI/esm1.5-scripts/blob/main/config-files/UM/um_env_to_yaml.py), which can be copied to the `<control-dir>/atmosphere` directory containing the `um_env.py` file, and run as follows:

```bash
$ module use /g/data/vk83/modules
$ module load payu # to load the pyyaml dependency
$ python um_env_to_yaml.py um_env.py

```

This will produce an equivalent `um_env.yaml` in the same directory which payu `1.1.5` will read for subsequent simulations.

### 2. `restart_date.nml` in the ice restart directory

Payu `1.1.5` simplifies the CICE submodel’s start date calculations, with the aim of making them easier to understand. One goal with these changes is to prevent situations where CICE’s calendar falls out of sync with the other submodels (see [this topic](https://forum.access-hive.org.au/t/payu-model-exited-with-error-code-1-aborting-stuck-at-a-leap-year/1038/14) for background on this issue).

Payu `1.1.5` reads the CICE start date completely from the `<restart-dir>/ice` directory, as opposed to the previous behaviour which mixed information between the restart and control directory.

The calendar information is read in from a new `restart_date.nml` file, an example of which can be found at `/g/data/vk83/configurations/inputs/access-esm1p5/modern/pre-industrial/restart/ice/restart_date.nml`:

```auto
&coupling
init_date=10101
inidate=1010101
/

```

Here, `init_date` is the “experiment’s initialisation date”, while `inidate` is the date that the next run will start at, both given in `YYYYMMDD` format without leading zeros for the year.

To continue an older experiment using payu `1.1.5`, a valid `restart_date.nml` file will need to be added to the final ice restart directory. This can be done as follows:

1. Copy the `restart_date.nml` file from `vk83` into the latest ice restart directory.
2. Replace `init_date` with the value in your `<control_directory>/ice/input_ice.nml` file.
3. Replace `inidate` with the date for the latest restart. This date can be read from the `<restart-dir>/atmosphere/um.res.yaml` and then converted to the `YYYYMMDD` format.

Do reply if you run into any issues adding in these changes!

---

<div class="post-metadata">

**Author:** ![RhaegarZeng](https://avatars.discourse-cdn.com/v4/letter/r/ea666f/32.png) [@RhaegarZeng](https://forum.access-hive.org.au/u/RhaegarZeng)\
**Post date:** [7 November 2024 06:00 UTC](https://forum.access-hive.org.au/t/updating-esm1-5-configurations-for-payu-version-1-1-5/3126/2 "2024-11-07T06:00:03Z")

</div>

A post was split to a new topic: [Encountering error while running simulations](https://forum.access-hive.org.au/t/encountering-error-while-running-simulations/3884)

---

<div class="post-metadata">

**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\
**Post date:** [7 November 2024 06:50 UTC](https://forum.access-hive.org.au/t/updating-esm1-5-configurations-for-payu-version-1-1-5/3126/3 "2024-11-07T06:50:00Z")

</div>

3 posts were merged into an existing topic: [Encountering error while running simulations](https://forum.access-hive.org.au/t/encountering-error-while-running-simulations/3884/2)
