Runtime Diagnostics Browser
===========================

.. contents::
   :local:
   :depth: 2

A pivotal tool for monitoring the behaviour of a simulation, is the use of the "runtime diagnostics". These typically
get produced in a specific "RTD" job, and produce 1-dimensional time-series plots of many different variables in the
``CanESM`` model.

Clint was never involved in deploying the browser on internal (``eccc-u2``) or external (``DRAC``) platforms, so interested
parties will need to talk with Neil Swart and Slava Kharin on this. The browser itself can be thought of as `separate`
from the main modelling pipeline, outside of the fact that it places the produced files in a
:ref:`staging directory <pertinent canesm configuration variables>`, which eventually get picked up by a ``cron`` job to
send it to the browser.

Pertinent CanESM configuration variables
----------------------------------------

As noted above within the modelling system, the only pertinent link to the "rtd browser" is the following configuration parameters:

.. code-block::

   cannemo_rtd_staging_dir # where the Ocean rtd job stages the files
   canam_rtd_staging_dir   # where the Agcm rtd job stages the files

Others typically setup a ``cron`` / ``hcron`` job to monitor these locations and move files to storage locations specific to the
rtd browser - **this means users can safely clean up rtd files from their own storage locations once they are served on the browser**.

.. note::

   To reduce how many ``cron`` / ``hcron`` jobs, users will generally want to put the ``rtd`` files in the same staging directory.
   **As such, these staging locations should be places where other members of the team can write to!**