Skip to content

Commit

Permalink
Merge pull request #413 from ACCESS-Hive/jasmeen/fix-warnings-410
Browse files Browse the repository at this point in the history
Jasmeen/fix warnings 410
  • Loading branch information
KAUR1984 authored Jul 10, 2023
2 parents e8a50c3 + 05a69eb commit 7c93b6a
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 38 deletions.
1 change: 0 additions & 1 deletion docs/community_resources/events/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Workshops and Conferences

TODO get the liquid working
{{ events_content }}

2 changes: 1 addition & 1 deletion docs/community_resources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Currently, we provide pointers to the following categories:
- [Glossaries](./glossaries/index.md)
- [Variables](./glossaries/glossary_cmip.md)
- [Model Evaluation Links](community_model_catalogs)
- [Training](../training/index.md)
- [Training](training/)
- [Events](./events/index.md)
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Tutorial for using `esmvaltool` on Gadi@NCI

{% include "call_contribute.md" %}
<!-- {% include "call_contribute.md" %} -->
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,22 @@

This tutorial explains how you can setup and run International Land Model Benchmarking (ILAMB) and International Ocean Model Benchmarking (IOMB) tests on `NCI` infrastracture. Both projects are maintained as `python` code under the package name `ilamb`.

The Tutorial contains:
1) [Background](#1-background-international-land-model-benchmarking-ilamb-and-international-ocean-model-benchmarking-iomb)
2) [Installation guide](#2-installing-ilamb)
3) [Setup details](#3-configuring-ilamb)
4) [Run `ilamb`](#4-run-ilamb)
5) [Run `liamb` on `NCI`](#5-run-ilamb-on-nci)
6) [Fix your setup with `ilamb-doctor`](#6-fix-your-interactive-setup-with-ilamb_doctor)
The Tutorial contains:

1. [Background](#1-background-international-land-model-benchmarking-ilamb-and-international-ocean-model-benchmarking-iomb)
2. [Installation guide](#2-installing-ilamb)
3. [Setup details](#3-configuring-ilamb)
4. [Run `ilamb`](#4-run-ilamb)
5. [Run `liamb` on `NCI`](#5-run-ilamb-on-nci)
6. [Fix your setup with `ilamb-doctor`](#6-fix-your-interactive-setup-with-ilamb_doctor)

## 1) Background: International Land Model Benchmarking (ILAMB) and International Ocean Model Benchmarking (IOMB)
## 1. Background: International Land Model Benchmarking (ILAMB) and International Ocean Model Benchmarking (IOMB)

As earth system models (ESMs) become increasingly complex, there is a growing need for comprehensive and multi-faceted evaluation of model projections. The International Land Model Benchmarking (ILAMB) project is a model-data intercomparison and integration project designed to improve the performance of land models and, in parallel, improve the design of new measurement campaigns to reduce uncertainties associated with key land surface processes.

If you have used (and installed) `ilamb` on NCI and know the basic principle of `ilamb`, you can start from [Section 5) Guide for using ilamb on NCI](#5-guide-for-use-on-nci).

## 2) Installing `ilamb`
## 2. Installing `ilamb`

For NCI users, ACCESS-NRI is providing a `conda` environment called `ilamb_dev` through the `xp65` project, with ilamb installed. You can load and activate it via:

Expand All @@ -30,7 +31,7 @@ We will soon add `ilamb` also to the ACCESS-NRI MED `conda` environment, `access

If you want to install `ilamb` yourself, please follow the official installation instructions at [https://www.ilamb.org/doc/install.html](https://www.ilamb.org/doc/install.html).

## 3) Configuring `ilamb`
## 3. Configuring `ilamb`

Before you can run `ilamb`, you need to configure a few things:

Expand All @@ -39,7 +40,7 @@ Before you can run `ilamb`, you need to configure a few things:
3.3. [Set up a `modelroute` and `regions` files](#33-set-up-modelroute-and-regions-files) (Optional, if you want to run only a subset of models and/or specific regions of the world)
3.4. [Download a `shapefiles` files locally](#33-download-a-shapefiles-files-locally) (Optional online, necessary offline e.g. on NCI compute nodes)

### 3.1) Organise the ILAMB_ROOT path
### 3.1 Organise the ILAMB_ROOT path

`ilamb` demands files to be organised in a specific directory structure of `DATA` and `MODELS`.

Expand Down Expand Up @@ -70,7 +71,7 @@ $ILAMB_ROOT (renamed from "ILAMB_sample")

There are two main branches in this directory. The first is the `DATA` directory–this is where we keep the observational datasets each in a subdirectory bearing the name of the variable. While not strictly necesary to follow this form, it is a convenient convention. The second branch is the `MODEL` directory in which we see a single model result from CLM.

#### 3.1.1) Add files to DATA
#### 3.1.1 Add files to DATA

There is a lot of DATA available to add. Take a look at https://www.ilamb.org/ILAMB-Data/ and https://www.ilamb.org/IOMB-Data/ for extensive lists for ILAMB-Data (land modelling) and IOMB-Data (ocean modelling).

Expand Down Expand Up @@ -104,13 +105,13 @@ ilamb-fetch --remote_root https://www.ilamb.org/IOMB-Data/
```


#### 3.1.2) Add files to MODEL
#### 3.1.2 Add files to MODEL

If you want to add your own `MODEL` to `ilamb`, you can do so by following [this description](https://www.ilamb.org/doc/add_model.html).

For `NCI` users, our `ilamb_dev` `conda` enrivonment already provides all observational datasets from the `ilamb` official web and the [ACCESS-ESM1_5](https://access-hive.org.au/configurations/access-esm/) model result for user at `ILAMB_ROOT`. Stay tune for more observational and model data or tell us which ones we should definitely add.

### 3.2) Set up a `config` file
### 3.2 Set up a `config` file

Now that we have the data, we need to setup a `config` file which the `ilamb` package will use to initiate a benchmark study.

Expand Down Expand Up @@ -198,7 +199,7 @@ weight = 1
```

### 3.3) Set up `modelroute` and `regions` files
### 3.3 Set up `modelroute` and `regions` files

If you plan to run only a specific subset of models, you can already define them in a `modelroute.txt` file. It could look like our specific example for running different versions (1, 2, and 3) of the ACCESS-ESM 1.5 suite:

Expand All @@ -210,7 +211,7 @@ ACCESS_ESM1-5-r3i1p1f1 , MODELS/r3i1p1f1 , CMIP6
... (abbreviated)
```

### 3.4) Download/link `shapefiles` files locally
### 3.4 Download/link `shapefiles` files locally

You can download the `shapefiles` that are needed to run `ilamb` and `cartopy` offline here:

Expand All @@ -227,9 +228,9 @@ Note: For NCI, we already provide shapefiles in a directory as part of project `
export CARTOPY_DATA_DIR=/g/data/xp65/public/apps/cartopy-data
```

## 4) Run `ilamb`
## 4. Run `ilamb`

### 4.1) ilamb-run
### 4.1 ilamb-run

Now that we have the configuration file set up, you can run the study using the `ilamb-run` script. Executing the following command at the $ILAMB_ROOT directory will run `ilamb` as specified in your `sample.cfg` for all models of the `model_root` and all regions (`global`) of the world:
```
Expand Down Expand Up @@ -264,15 +265,15 @@ Next we ran all model-confrontation pairs. In our parlance, a confrontation is a

The next stage is the post-processing. This is done as a separate loop to exploit some parallelism. All the work in a model-confrontation pair is purely local to the pair. Yet plotting results on the same scale implies that we know the maxmimum and minimum values from all models and thus requires the communcation of this information. Here, as we are plotting only over the globe and not extra regions, the plotting occurs quickly.

### 4.2) Run specific models and regions
### 4.2 Run specific models and regions

As mentioned in [Section 3.3](#33-set-up-modelroute-and-regions-files), you can adjust the models and regions that `ilamb` will run on. You can find more information in the `ilamb` [tutorial](https://www.ilamb.org/doc/ilamb_run.html). Calling `ilamb-run` with both specifications, would look like:
```
ilamb-run --config cmip.cfg --model_setup modelroute.txt --regions regions.txt
```
where you call a specific config file (see [Section 3.2](#32-set-up-a-config-file)) as well as specific model routes and regions with files (see [Section 3.3](#33-set-up-modelroute-and-regions-files)).

### 4.3) Viewing the benchmarking output in your browser
### 4.3 Viewing the benchmarking output in your browser

The whole process generates a directory of results within ILAMB_ROOT which by default is called `_build`. To view the results locally on your computer, navigate into this directory and start a local `http` server:
```
Expand All @@ -284,21 +285,21 @@ Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
```
Open this link in your browser and you will see a webpage with a summary table in the center. As we have so few variables and a single model at this point, the table will very simple:

<p align="center"><img align="center" width="30%" src="../../assets/model_evaluation/ilamb_output_1.png" alt="Starting side of ilamb output"></p>
<p align="center"><img align="center" width="30%" src="../../../assets/model_evaluation/ilamb_output_1.png" alt="Starting side of ilamb output"></p>

As we add more variables and models, this summary table helps you understand relative differences in scores among models. For now, clicking on a row of the table will expand it to reveal the underlying datasets used. Clicking on CERES will take you to another page which presents detailed scores and plots.

<p align="center"><img align="center" width="50%" src="../../assets/model_evaluation/ilamb_output_2.png" alt="Detailed output of Surface Upward SW Radiation Benchmarking"></p>
<p align="center"><img align="center" width="50%" src="../../../assets/model_evaluation/ilamb_output_2.png" alt="Detailed output of Surface Upward SW Radiation Benchmarking"></p>

## 5) Run `ilamb` on NCI
## 5. Run `ilamb` on NCI

If you followed the guides above, you should be familiar with how you can setup `ilamb`.

To run `ilamb` on NCI, you can either start an interactive setup [Section 5.1](#51-interactive-setup-on-nci) or use a non-interactive Portable Batch System (PBS) job [Section 5.2](#52-portable-batch-system-pbs-jobs-on-NCI).

In both cases, you need to again define the variable `$ILAMB_ROOT`

### 5.1) ILAMB_ROOT and DATA/MODEL on NCI
### 5.1 ILAMB_ROOT and DATA/MODEL on NCI

In our default setup, we will place ILAMB_ROOT and the shapefiles for cartopy directly in the home directory. First, you have to create the ILAMB_ROOT directory
```
Expand Down Expand Up @@ -355,7 +356,7 @@ or shorter
source = $ILAMB_ROOT/MODELS/r1i1p1f1/Amon/rsus/gn/files/d20191115/rsus_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc
```

### 5.2) Portable Batch System (PBS) jobs on NCI
### 5.2 Portable Batch System (PBS) jobs on NCI

The following default PBS file, let's call it `ilamb_test.sh` can help you to setup your own, while making sure to use the correct project (#PBS -P) to charge your computing cost to:
```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Tutorial for using `pangeo` & COSIMA on Gadi@NCI

{% include "call_contribute.md" %}
<!-- {% include "call_contribute.md" %} - commented to fix terminal warnings -->

https://pangeo.io
8 changes: 4 additions & 4 deletions docs/models/run-a-model/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ If *Model*, *Model Component* or *Model Configuration* are not familiar terms fo
If you have not run a model before, our [Getting Started Guide](./access_to_gadi_at_nci.md) will give you the basics to access the Model infrastructure on the high-performance-computing facility Gadi@NCI.

Detailed guides for the different Model configurations can then be found on the following pages:
- [Run ACCESS-ESM](../running-access-esm.md) for the ACCESS Earth System Model configurations
- [Run ACCESS-CM](../running-access-cm.md) for the ACCESS Coupled Model configurations
- [Run ACCESS-AM](../running-access-am.md) for the ACCESS Atmosphere Model configurations
- [Run ACCESS-OM](../running-access-om.md) for the ACCESS Ocean Model configurations
- [Run ACCESS-ESM](../run-access-esm.md) for the ACCESS Earth System Model configurations
- [Run ACCESS-CM](../run-access-cm.md) for the ACCESS Coupled Model configurations
- [Run ACCESS-AM](../run-access-am.md) for the ACCESS Atmosphere Model configurations
- [Run ACCESS-OM](../run-access-om.md) for the ACCESS Ocean Model configurations
8 changes: 4 additions & 4 deletions docs/models/run-a-model/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If *Model*, *Model Component* or *Model Configuration* are not familiar terms fo
If you have not run a model before, our [Getting Started Guide](./getting_started/access_to_gadi_at_nci.md) will give you the basics to access the Model infrastructure on the high-performance-computing facility Gadi@NCI.

Detailed guides for the different Model configurations can then be found on the following pages:
- [Run ACCESS-ESM](./running-access-esm.md) for the ACCESS Earth System Model configurations
- [Run ACCESS-CM](./running-access-cm.md) for the ACCESS Coupled Model configurations
- [Run ACCESS-AM](./running-access-am.md) for the ACCESS Atmosphere Model configurations
- [Run ACCESS-OM](./running-access-om.md) for the ACCESS Ocean Model configurations
- [Run ACCESS-ESM](./run-access-esm.md) for the ACCESS Earth System Model configurations
- [Run ACCESS-CM](./run-access-cm.md) for the ACCESS Coupled Model configurations
- [Run ACCESS-AM](./run-access-am.md) for the ACCESS Atmosphere Model configurations
- [Run ACCESS-OM](./run-access-om.md) for the ACCESS Ocean Model configurations
2 changes: 1 addition & 1 deletion docs/models/run-a-model/run-access-cm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It is also built as a future point of reference, where you can come back and fin
- A Linux/Mac/Unix computer with an internet connection and a command line terminal (e.g., MacOS with XQuartz and command line tools installed, or Putty Cygwin/MobaXterm/similar X-Windows compatible program on a PC).
### Requirements for running ACCESS-CM suites

Here, we assume that you already have access to Gadi, the supercomputer hosted by the National Computational Infrastructure (NCI). If needed, you can go back to our guide on how to get [access to Gadi](../running-a-model/getting_started/access_to_gadi_at_nci.md).
Here, we assume that you already have access to Gadi, the supercomputer hosted by the National Computational Infrastructure (NCI). If needed, you can go back to our guide on how to get [access to Gadi](../run-a-model/getting_started/access_to_gadi_at_nci.md).

#### Basic Setup
To run an ACCESS-CM suite, new users will need to:
Expand Down

0 comments on commit 7c93b6a

Please sign in to comment.