<a id="quick-start-guide"></a>

# Quick Start Guide

<!-- Glossary substitutions make it easier to refer to pluralised / -->
<!-- capitalised glossary terms. -->
<!-- Links -->
* Clone the ESMValTool repository (which contains the [RTW](../glossary.html.md#term-RTW)):
  ```default
  git clone git@github.com:ESMValGroup/ESMValTool.git
  ```
* Configure the [RTW](../glossary.html.md#term-RTW):
  ```default
  cd ESMValTool/esmvaltool/utils/recipe_test_workflow
  rose edit
  ```
* Run the [RTW](../glossary.html.md#term-RTW):
  * at the Met Office:
    ```default
    export CYLC_VERSION=8
    cylc vip -O metoffice
    ```
  * on JASMIN:
    * add the following line to your `~/.bashrc` file to ensure the Cylc and
      Rose executables can be found:
      ```default
      export PATH=/apps/jasmin/metomi/bin:$PATH
      ```
    * SSH to the Rose and Cylc server:
      ```default
      ssh -X cylc
      ```
    * run the RTW on JASMIN:
      ```default
      cd ESMValTool/esmvaltool/utils/recipe_test_workflow
      export CYLC_VERSION=8
      cylc vip -O jasmin
      ```
  * on DKRZ:
    * add the following line to your `~/.bashrc` file to ensure the Cylc and
      Rose executables can be found:
      ```default
      export PATH=/work/bd0854/metomi/bin:$PATH
      ```
    * run the RTW on DKRZ:
      ```default
      cd ESMValTool/esmvaltool/utils/recipe_test_workflow
      cylc vip -O dkrz
      ```
* Optionally browse the logs using [Cylc Review](https://cylc.github.io/cylc-doc/7.9.3/html/tutorial.html#viewing-suite-logs-in-a-web-browser-cylc-review),
  a web service for browsing logs via an HTTP interface.
