diff --git a/README.md b/README.md index e05d1e8c85e152dc1028fee87f0877010d72e18f..c5f218d7b48d28995777570ff76b068b53350786 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,31 @@ ## Table of Contents -- [Introduction to the Atmospheric Machine Learning Benchmarking System](#Introduction-to-Atmospheric-Machine-Learning-Benchmarking-System) -- [Requirements](#Requirements) -- [Getting started](#Getting-started) - * [Download of the repository](#Download-of-the-repository) - * [Download of NVIDIA's TF1.15 singularity container](#Download-of-NVIDIA's-TF1.15-singularity-container) - * [Workflow without singularity containers](#Download-without-singularity-containers) - * [Virtual environment](#Virtual-environment) - + [On HPC-systems](#On-HPC-systems) - + [On other systems](#On-other-systems) - + [Further details on the arguments](#Further-details-on-the-arguments) - - [Case I - Usage of singularity TF1.15 container](#case-i---usage-of-singularity-tf115-container) - - [Case II - Usage of singularity TF1.15 container](#case-ii---usage-of-singularity-tf115-container) - - [Further details on the arguments](#further-details-on-the-arguments) -- [Get the datasets](#Get-the-datasets) - + [Complete dataset (> 100 GB memory)](#Complete-dataset-(>-100-GB-memory)) - + [Toy dataset](#Toy-dataset) - + [Climatological reference data](#Climatological-reference-data) -- [Run the workflow](#Run-the-workflow) - + [Create customized runscripts](#create-customized-runscripts) - * [Running the workflow steps](#Running-the-workflow-steps) - * [Additional Jupyter Notebooks](#Additional-Jupyter-Notebooks) -- [Directory tree and naming convention](#Directory-tree-and-naming-convention) -- [Benchmarking architectures](#Benchmarking-architectures) -- [Contributors and contact](#Contributors-and-contact) +- [Introduction to Atmospheric Machine Learning Benchmarking System](#introduction-to-atmospheric-machine-learning-benchmarking-system) +- [Requirements](#requirements) +- [Getting started](#getting-started) + * [Download of the repository](#download-of-the-repository) + * [Download of NVIDIA's TF1.15 singularity container](#download-of-nvidia-s-tf115-singularity-container) + * [Workflow without singularity containers](#workflow-without-singularity-containers) + * [Virtual environment](#virtual-environment) + + [On HPC-systems](#on-hpc-systems) + - [Case I - With TF1.15 singularity container](#case-i---with-tf115-singularity-container) + - [Case II - Without TF1.15 singularity container, but with software modules](#case-ii---without-tf115-singularity-container--but-with-software-modules) + + [On other systems](#on-other-systems) + + [Further details on the arguments](#further-details-on-the-arguments) +- [Get the datasets](#get-the-datasets) + * [Complete ERA5 dataset (> 100 GB memory)](#complete-era5-dataset----100-gb-memory-) + * [Toy dataset](#toy-dataset) + * [Climatological reference data](#climatological-reference-data) +- [Run the workflow](#run-the-workflow) + * [Create customized runscripts](#create-customized-runscripts) + * [Running the workflow steps](#running-the-workflow-steps) + * [Additional Jupyter Notebooks](#additional-jupyter-notebooks) +- [Directory tree and naming convention](#directory-tree-and-naming-convention) + + [Overview on placeholders of the output directory tree](#overview-on-placeholders-of-the-output-directory-tree) + + [Directory name convention](#directory-name-convention) +- [Benchmarking architectures](#benchmarking-architectures) +- [Contributors and contact](#contributors-and-contact) ## Introduction to Atmospheric Machine Learning Benchmarking System