Skip to content

Commit

Permalink
add original changes to ilamb
Browse files Browse the repository at this point in the history
  • Loading branch information
flicj191 committed Jun 19, 2024
1 parent bc195b6 commit 9e839b5
Showing 1 changed file with 16 additions and 23 deletions.
39 changes: 16 additions & 23 deletions docs/model_evaluation/evaluation_on_gadi/ilamb_workflow.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,49 @@
# ILAMB-workflow on Gadi
# ACCESS-NRI ILAMB-workflow at NCI

## What is ILAMB?

The <a href="https://www.ilamb.org/" target="_blank">International Land Model Benchmarking (<i>ILAMB</i>)</a> benchmarking system is a python framework used to quantitatively compare a defined set of observable variables with a number of land models.

This documentation is tailored to using <i>ILAMB</i> on <i>Gadi</i> and, hence, it supplements rather than replaces the official documentation. Users are encouraged to read the <a href="https://www.ilamb.org/doc/" target="_blank">ILAMB documentation</a> and relevant <a href="https://www.ilamb.org/doc/tutorial.html" target="_blank">tutorials</a>.

<div class="note">ACCESS-NRI is supporting an NCI configuration of ILAMB under the name <i>ILAMB-workflow</i>. </div>
ACCESS-NRI is releasing an NCI configuration of ILAMB under the name **ILAMB-workflow**.

*ILAMB-workflow* is the ACCESS-NRI software and data infrastructure that enables the ILAMB evaluation framework on NCI Gadi. It includes the

- *ILAMB* Python packages,
- a series of *ILAMB* outputs for ACCESS model evaluation,
- the *ILAMB-Data* collection of observational datasets.

ILAMB-workflow is configured to use the existing NCI supported CMIP data collections.
**ILAMB-workflow** is the ACCESS-NRI software and data infrastructure that enables the ILAMB evaluation framework on NCI Gadi. It includes the **ILAMB Python packages**, a series of **ILAMB outputs for ACCESS model evaluation** and the **ILAMB-Data collection of observational datasets**. ILAMB-workflow is configured to use the existing NCI supported CMIP data collections.

## Using ILAMB on Gadi

### Pre-requisites

To use *ILAMB* on *Gadi* ensure you fulfill the [First Steps](/getting_started/first_steps) section.
<i>ILAMB</i> is provided through the <a href="https://my.nci.org.au/mancini/project/xp65/join" target="_blank">xp65</a> NCI projects on <i>Gadi</i>, so you need to have an NCI account and be a member of this projects to use it.
<i>ILAMB</i> is provided through the `xp65` NCI projects on <i>Gadi</i>, so you need to have an NCI account and be a member of this projects to use it.

<div class='admonition warning'>
<div class="note">
To obtain an NCI account and join NCI projects, refer to <a href="/getting_started/first_steps" target="_blank">First Steps</a>.
</div>

Depending on your needs, you may want to also join the following supported data collections:

- CMIP6: <a href="https://my.nci.org.au/mancini/project/fs38/join" target="_blank">fs38</a>, <a href="https://my.nci.org.au/mancini/project/oi10/join" target="_blank">oi10</a>
- CMIP5: <a href="https://my.nci.org.au/mancini/project/rr3/join" target="_blank">rr3</a>, <a href="https://my.nci.org.au/mancini/project/al33/join" target="_blank">al33</a>
- CMIP6: `fs38`, `oi10`
- CMIP5: `rr3`, `al33`

### Loading the ILAMB-workflow modules
<!-- #### Load the `access-med` conda environment -->

To load the the *ilamb* module, execute the following commands:
To load the the `ilamb` module, execute the following commands:
```
module use /g/data/xp65/public/modules
module load conda/access-med
```

Visit <a href="https://ilamb-workflow.readthedocs.io/en/latest/?badge=latest" target="_blank">ACCESS-NRI documentation</a> on how to run <i>ILAMB</i> on <i>Gadi</i>.
For ACCESS-NRI documentation on how to run <i>ILAMB</i> on <i>Gadi</i>, visit:

<!-- <div class="card-container">
<div class="card-container">
<a href="https://ilamb-workflow.readthedocs.io/en/latest/?badge=latest" class="vertical-card aspect-ratio2to1" target="_blank">
<div class="card-image-container">
<img src="/assets/model_evaluation/logo_ilamb.png" alt="ILAMB on Gadi" class="img-cover white-background"></img>
</div>
<div class="card-text-container bold ">Documentation for ILAMB on Gadi</div>
</a>
</div> -->
</div>

<br>
To run <i>ILAMB</i>, you need to execute the command `ilamb-run` with a number of arguments/ files:
Expand All @@ -59,16 +52,16 @@ ilamb-run --config config.cfg --model_setup model_setup.txt --regions regions.tx
```
<ul>
<li>
<i>config.cfg</i> defines which observables and observational datasets to be compared.
<code>config.cfg</code> defines which observables and observational datasets to be compared.
<li>
<i>model_setup.txt</i> defines the paths of models that to be compared.
<code>model_setup.txt</code> defines the paths of models that to be compared.
<li>
<i>regions.txt</i> defines the regions to be compared, e.g., <i>global</i>, <i>aust</i> (Australia), etc.
<code>regions.txt</code> defines the regions to be compared, e.g., <code>global</code>, <code>aust</code> (Australia), etc.
</ul>

While these files can be self-defined, ACCESS-NRI provides the necessary files and tools to set your model paths to run on <i>Gadi</i>. All you need to do is decide which observations and models you wish to compare.
<br>
NCI hosts replicas of the <i>ILAMB</i> observational data sets through the NCI project <a href="https://my.nci.org.au/mancini/project/ct11/join" target="_blank">ct11</a> as well as a large amount of model outputs are available on <i>Gadi</i>, such as ACCESS model output.
NCI hosts replicas of the <i>ILAMB</i> observational data sets through the NCI project `ct11` as well as a large amount of model outputs are available on <i>Gadi</i>, such as ACCESS model output.

For more information, refer to <a href="\model_evaluation/model_evaluation_observational_catalogs" target="_blank">Observational Data Catalogue</a> on how to find observational data on NCI and <a href="\model_evaluation/model_evaluation_model_catalogs" target="_blank">ACCESS-NRI Intake Catalog</a> for how to find model outputs.
<br>
Expand All @@ -90,7 +83,7 @@ In the following example, the supported ACCESS Earth System Model (ESM) <a href=

Numerous benchmark comparisons have been defined in the configuration file. The comparison of variables have been organised under different sections, such as the <i>Hydrology Cycle</i>.
<br>
For other variables, such as the <i>git Gross Primary Productivity</i> (*gpp*), one or more datasets are available. For example, the gross primary productivity measurements of <a href="https://fluxnet.org/data/fluxnet2015-dataset/" target="_blank">FLUXNET2015</a>.
For other variables, such as the <i>git Gross Primary Productivity</i> `gpp`, one or more datasets are available. For example, the gross primary productivity measurements of <a href="https://fluxnet.org/data/fluxnet2015-dataset/" target="_blank">FLUXNET2015</a>.
<br>
<br>
By clicking on a row in the table, you can expand it to see the underlying datasets used. The table's colourmap extends from best values in purple to worse data in orange.
Expand Down

0 comments on commit 9e839b5

Please sign in to comment.