ESMValTool

https://docs.esmvaltool.org/en/latest/
Admin
ESMValTool is a community diagnostics and performance metrics tool for the evaluation of Earth...
Tokens:645,135
Snippets:4,555
Trust Score:8.3
Update:4 days ago
Show doc for...
Tokens:
Raw
### Finalize development setup

Source: https://docs.esmvaltool.org/en/latest/quickstart/installation.html

Activates the development environment and installs pre-commit hooks for code formatting.

```bash
pixi shell -e esmvalcore-dev
```

```bash
pre-commit install
```

--------------------------------

### Command Line Example

Source: https://docs.esmvaltool.org/en/latest/tutorials/template.html

A basic example of a command line instruction.

```bash
my command
```

--------------------------------

### List installed recipes

Source: https://docs.esmvaltool.org/en/latest/_sources/quickstart/running.rst.txt

Prints a complete list of all installed recipes to the console.

```bash
esmvaltool recipes list
```

--------------------------------

### Example Preprocessor Configuration

Source: https://docs.esmvaltool.org/en/latest/_modules/esmvaltool/diag_scripts/ocean/diagnostic_model_vs_obs.html

An example configuration for a preprocessor suitable for 3D + time fields before passing them to the diagnostic.

```yaml
preprocessors:
    prep_map:
      extract_levels:
        levels:  [100., ]
        scheme: linear_extrap
      climate_statistics:
        operator: mean
      regrid:
        target_grid: 1x1
        scheme: linear
```

--------------------------------

### Example Preprocessor Configuration

Source: https://docs.esmvaltool.org/en/latest/_modules/esmvaltool/diag_scripts/ocean/diagnostic_seaice.html

An example configuration for an ESMValTool preprocessor to prepare data for the sea ice diagnostic.

```yaml
  preprocessors:
    timeseries_NHW_ice_extent: # North Hemisphere Winter ice_extent
      custom_order: true
      extract_time:
          start_year: 1960
          start_month: 12
          start_day: 1
          end_year: 2005
          end_month: 9
          end_day: 31
      extract_season:
        season: DJF
      extract_region:
        start_longitude: -180.
        end_longitude: 180.
        start_latitude: 0.
        end_latitude: 90.
```

--------------------------------

### Enter the ESMValTool directory and activate the environment

Source: https://docs.esmvaltool.org/en/latest/quickstart/installation.html

Navigate to the source directory and use pixi to create and activate the development environment.

```bash
cd ESMValTool
```

```bash
pixi shell --frozen
```

--------------------------------

### Get details for a ruff rule

Source: https://docs.esmvaltool.org/en/latest/_sources/community/code_documentation.rst.txt

Shows a detailed explanation of a specific ruff rule, using RET504 as an example rule code.

```bash
ruff rule RET504
```

--------------------------------

### Configure autoassess_landsurf_surfrad in YAML

Source: https://docs.esmvaltool.org/en/latest/_sources/recipes/recipe_autoassess_landsurface_surfrad.rst.txt

Example configuration for the autoassess_landsurf_surfrad diagnostic, showing the required start and end date format for the Surfrad metric.

```yaml
scripts:
  autoassess_landsurf_surfrad: &autoassess_landsurf_surfrad_settings
    script: autoassess/autoassess_area_base.py
    title: "Autoassess Land-Surface Diagnostic Surfrad Metric"
    area: land_surface_surfrad
    control_model: UKESM1-0-LL
    exp_model: UKESM1-0-LL
    obs_models: [CERES-EBAF]
    obs_type: obs4MIPs
    start: 1997/12/01
    end: 2002/12/01
```

--------------------------------

### Initialize Datasets

Source: https://docs.esmvaltool.org/en/latest/_modules/esmvaltool/diag_scripts/shared/_diag.html

Get all variables of a recipe configuration `cfg`.

```python
datasets = Datasets(cfg)
```

--------------------------------

### Configure autoassess_area_base.py in recipe

Source: https://docs.esmvaltool.org/en/latest/recipes/recipe_autoassess_stratosphere.html

Example configuration for the stratosphere diagnostic metric using the autoassess_area_base.py wrapper. Note the use of YYYY/MM/DD format for start and end dates to accommodate native Autoassess time gating requirements.

```yaml
scripts:
  autoassess_strato_test_1: &autoassess_strato_test_1_settings
    script: autoassess/autoassess_area_base.py  # the base wrapper
    title: "Autoassess Stratosphere Diagnostic Metric"  # title
    area: stratosphere  # assesment area
    control_model: UKESM1-0-LL-hist  # control dataset name
    exp_model: UKESM1-0-LL-piCont  # experiment dataset name
    obs_models: [ERA-Interim]  # list to hold models that are NOT for metrics but for obs operations
    additional_metrics: [ERA-Interim]  # list to hold additional datasets for metrics
    start: 2004/12/01  # start date in native Autoassess format
    end: 2014/12/01  # end date in native Autoassess format
```

--------------------------------

### Example recipe log output

Source: https://docs.esmvaltool.org/en/latest/_sources/utils/RTW/add_a_recipe.rst.txt

The actual duration and memory usage can be found in the main_log.txt file.

```text
YYYY-MM-DD HH:MM:SS:sss UTC [12345] INFO    Time for running the recipe was: 0:02:13.334742
YYYY-MM-DD HH:MM:SS:sss UTC [12345] INFO    Maximum memory used (estimate): 2.4 GB
[...]
YYYY-MM-DD HH:MM:SS:sss UTC [12345] INFO    Run was successful
```

--------------------------------

### Build documentation using pixi

Source: https://docs.esmvaltool.org/en/latest/_sources/community/code_documentation.rst.txt

Alternative command to build documentation using the pixi task runner.

```bash
pixi run doc
```

--------------------------------

### Install default configuration

Source: https://docs.esmvaltool.org/en/latest/_sources/quickstart/configuration.rst.txt

Run this command to copy the default configuration file to the default location. The resulting file must be customized to point to your local data before running recipes.

```bash
esmvaltool config copy defaults/config-user.yml
```

--------------------------------

### Example log_provenance call in NCL

Source: https://docs.esmvaltool.org/en/latest/community/diagnostic.html

A concrete example of calling log_provenance with specific arguments.

```console
log_provenance(ncdf_outfile, \
               map@outfile, \
               "Mean of variable: " + var0, \
               "mean", \
               "global", \
               "geo", \
               (/"righi_mattia", "gottschaldt_klaus-dirk"/), \
               (/"acknow_author"/), \
               metadata_att_as_array(info0, "filename"))
```

--------------------------------

### Install with Pip

Source: https://docs.esmvaltool.org/en/latest/_sources/quickstart/installation.rst.txt

Install ESMValTool via pip after manually satisfying non-PyPI dependencies.

```bash
pip install esmvaltool
```

--------------------------------

### Build documentation from scratch

Source: https://docs.esmvaltool.org/en/latest/_sources/community/code_documentation.rst.txt

Command to build documentation from scratch by ignoring cached files.

```bash
sphinx-build -Ea doc/sphinx/source/ doc/sphinx/build/
```

--------------------------------

### Verify Mamba installation

Source: https://docs.esmvaltool.org/en/latest/_sources/quickstart/installation.rst.txt

Check that the mamba executable is correctly installed and accessible in your path.

```bash
which mamba
```
Tokens:
Raw