From 1b3bdd9355201dfa86b107fb33bf2ab415347ff6 Mon Sep 17 00:00:00 2001 From: Baudouin Raoult Date: Sun, 17 Nov 2024 18:49:41 +0000 Subject: [PATCH] add documentation --- docs/configs/forcings.rst | 3 +++ docs/configs/inputs.rst | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/configs/forcings.rst b/docs/configs/forcings.rst index 52e26fd..fc17a0f 100644 --- a/docs/configs/forcings.rst +++ b/docs/configs/forcings.rst @@ -9,4 +9,7 @@ conditions. If the model need data during the run (dynamic forcings), the forcings will be fetched by default from the same source as the input. However, you can specify a different source. +The example below shows an example where the forcings are fetched from +``mars`` while the initial conditions are fetched from ``test``. + .. literalinclude:: forcings_1.yaml diff --git a/docs/configs/inputs.rst b/docs/configs/inputs.rst index 2af2338..8343b10 100644 --- a/docs/configs/inputs.rst +++ b/docs/configs/inputs.rst @@ -7,7 +7,7 @@ The input methods listed below are used to fetch the initial conditions of a model run. They will also be the source of forcings during the model run, unless a ``forcing`` entry is specified in the configuration -(see :ref:`forcings``). +(see :ref:`forcings`). ********** Datasets