.. _RuntimeEnvironment:

=========================
Runtime Environment
=========================

Build the Environment
------------------------------------------------------------------------------

To build the EAGLE runtime virtual environments:

.. code-block:: bash

    make env cudascript=<name-or-path> # alternatively: ./setup cudascript=<name-or-path>

This will install :term:`Miniforge conda` in the current directory and create the various virtual environments.

The value of the ``cudascript=`` argument should be either the name of a file under ``src/cuda/`` (e.g. ``cudascript=ursa``), 
or an arbitrary path to a file (e.g. ``cudascript=/path/to/file``). The file should contain a list of commands that need 
to be executed on the current system to make the CUDA ``nvcc`` program available on ``PATH``. The ``setup`` script uses ``nvcc`` 
to determine the CUDA release number, used to select a matching ``flash-attn`` package. For systems needing no special 
setup to make ``nvcc`` available, ``cudascript=none`` may be specified.

Available Make Targets
------------------------------------------------------------------------------

A variety of ``make`` targets are available to execute pipeline steps.

Run ``make`` with no arguments to list available targets.

.. list-table:: Available make targets
   :widths: 20 20 20 20
   :header-rows: 1

   * - Target
     - Purpose
     - Depends on target
     - Uses environment
   * - data
     - Implies grids-and-meshes, zarr-gfs, zarr-hrrr
     - ---
     - data
   * - grids-and-meshes
     - Prepare grids and meshes
     - ---
     - data
   * - zarr-gfs
     - Prepare :term:`Zarr`-formatted :term:`GFS` input data
     - grids-and-meshes
     - data
   * - zarr-hrrr
     - Prepare Zarr-formatted :term:`HRRR` input data
     - grids-and-meshes
     - data
   * - training
     - Performs anemoi training
     - data
     - anemoi
   * - inference
     - Performs anemoi inference
     - training
     - anemoi
   * - vx-grid-global
     - Verify global against gridded analysis
     - inference
     - wxvx
   * - vx-grid-lam
     - Verify LAM against gridded analysis
     - inference
     - wxvx
   * - vx-obs-global
     - Verify global against obs
     - inference
     - wxvx
   * - vx-obs-lam
     - Verify LAM against obs
     - inference
     - wxvx
   * - vis-grid-global
     - Visualize global VX results against gridded analysis
     - vx-grid-global
     - visualization
   * - vis-grid-lam
     - Visualize LAM VX results against gridded analysis
     - vx-grid-lam
     - visualization
   * - vis-obs-global
     - Visualize global VX results against obs
     - vx-obs-global
     - visualization
   * - vis-obs-lam
     - Visualize LAM VX results against obs
     - vx-obs-lam
     - visualization