Welcome to ESM Tools’s documentation!

Contents:

• Introduction
• Get ESM-Tools
  • Downloading
  • Accessing components in DKRZ server
• Before you continue
• Ten Steps to a Running Model
• Installation
  • Prerequisite
  • Installing in local environment
  • Installing in a conda environment
  • Installing in an encapsulated environment using direnv
  • Update ESM-Tools
  • Uninstall ESM-Tools
• ESM Tools
  • Options
  • Subcommands
• YAML File Syntax
  • What Is YAML?
  • ESM-Tools Extended YAML Syntax
• Templating files with Jinja
• YAML File Hierarchy
  • Hierarchy of YAML configuration files
  • How can I know where a parameter is defined?
• ESM-Tools Variables
  • Tool-Specific Elements/Variables
• ESM Master
  • Usage: esm_master
  • Configuring esm-master for Compile-Time Overrides
• ESM-Versions (deprecated)
  • Usage
• ESM Runscripts
  • Usage
  • Arguments
  • Running a Model/Setup
  • Job Phases
  • Running only part of a job
  • Experiment Directory Structure
  • Cleanup of run_ directories
  • Debugging an Experiment
  • Configuration Provenance
  • Setting the file movement method for filetypes in the runscript
  • Running an experiment with a virtual environment
• ESM Runscripts - Using the Workflow Manager
  • Introduction
  • Subjobs of a normal run
  • Keywords available for defining additional data processing subjobs
  • Example 1: Adding an additional postprocessing subjob
  • Example 2: Adding an additional preprocessing subjob
  • Example 3: Adding a iterative coupling job
• ESM Environment
  • Environment variables
  • Modification of the environment through the model/setup files
  • Coupled setup environment control
• ESM-Tests
  • Glossary
  • Usage
  • Arguments
  • Last-state
  • Check test status
  • Model control file (config.yaml)
  • Local test configuration (test_config.yaml)
  • ESM-Tests cookbook
• ESM MOTD
• Cookbook
  • Change/Add Flags to the sbatch Call
  • Applying a temporary disturbance to ECHAM to overcome numeric instability (lookup table overflows of various kinds)
  • Changing Namelist Entries from the Runscript
  • Heterogeneous Parallelization Run (MPI/OpenMP)
  • How to setup runscripts for different kind of experiments
  • Implement a New Model
  • Implement a New Coupled Setup
  • Implement a New HPC Machine
  • Include a New Forcing/Input File
  • Exclude a Forcing/Input File
  • Using your own namelist
  • How to branch-off FESOM from old spinup restart files
  • Recieve batch notifications via e-mail
  • AWI-ESM1/2 simulations with modified topography
• Frequently Asked Questions
  • Installation
  • ESM Runscripts
  • ESM Master
  • Frequent Errors
• Python Packages
  • esm_tools.git
  • esm_master.git
  • esm_runscripts.git
  • esm_parser.git
  • esm_calendar.git
• ESM Tools Code Documentation
  • esm_archiving package
  • esm_archiving.external package
  • esm_calendar package
  • esm_cleanup package
  • esm_database package
  • esm_environment package
  • esm_master package
  • esm_motd package
  • esm_parser package
  • esm_plugin_manager package
  • esm_profile package
  • esm_runscripts package
  • esm_tests package
  • esm_tools package
  • esm_utilities package
• Supported Models
  • AMIP
  • DEBM
  • ECHAM
  • ESM_INTERFACE
  • FESOM
  • FESOM_MESH_PART
  • HDMODEL
  • ICON
  • JSBACH
  • MEDUSA
  • MPIOM
  • NEMO
  • NEMOBASEMODEL
  • OASIS3MCT
  • OpenIFS
  • PISM
  • PISM_NH
  • PISM_SH
  • RECOM
  • RNFMAP
  • SCOPE
  • TUX
  • VILMA
  • XIOS
  • YAC
  • YAXT
• Transitioning from the Shell Version
  • ESM-Master
  • ESM-Environment
  • ESM-Runscripts
  • Functions –> Configs + Python Packages
  • Namelists
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Deploying
• How to cite the software
• Credits
  • Development Lead
  • Project Management
  • Contributors
  • Beta Testers

Indices and tables

• Index

• Module Index

• Search Page