From 756cecefd4f9fdb10d03dde8ac4d606046ec2776 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Wed, 11 Nov 2020 14:28:00 +0100 Subject: [PATCH] Documentation examples tuning (2) --- doc/en/ref_algorithm_3DVAR.rst | 2 ++ doc/en/scripts/simple_3DVAR.rst | 16 ++++++++++++++++ doc/en/snippets/Header2Algo09.rst | 6 +++--- doc/fr/ref_algorithm_3DVAR.rst | 2 ++ doc/fr/scripts/simple_3DVAR.rst | 16 ++++++++++++++++ doc/fr/snippets/Header2Algo09.rst | 6 +++--- 6 files changed, 42 insertions(+), 6 deletions(-) create mode 100644 doc/en/scripts/simple_3DVAR.rst create mode 100644 doc/fr/scripts/simple_3DVAR.rst diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst index 4a51b39..83985a5 100644 --- a/doc/en/ref_algorithm_3DVAR.rst +++ b/doc/en/ref_algorithm_3DVAR.rst @@ -195,6 +195,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_3DVAR.rst + .. literalinclude:: scripts/simple_3DVAR.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/en/scripts/simple_3DVAR.rst b/doc/en/scripts/simple_3DVAR.rst new file mode 100644 index 0000000..326ec70 --- /dev/null +++ b/doc/en/scripts/simple_3DVAR.rst @@ -0,0 +1,16 @@ +.. index:: single: 3DVAR (example) + +This example describes the calibration of parameters :math:`\mathbf{x}` of a +quadratic observation model :math:`H`. This model is here represented as a +function named ``QuadFunction``. This function get as input the coefficients +vector :math:`\mathbf{x}`, and return as output the evaluation vector +:math:`\mathbf{y}` of the quadratic model at the predefined internal control +points. The calibration is done using an initial coefficient set (background +state specified by ``Xb`` in the code), and with the information +:math:`\mathbf{y}^o` (specified by ``Yobs`` in the code) of 5 measures obtained +in these same internal control points. We choose to emphasize the observations +versus the background by setting a great variance for the background error, +here of :math:`10^{6}`. + +The adjustment is carried out by displaying intermediate results during +iterative optimization. diff --git a/doc/en/snippets/Header2Algo09.rst b/doc/en/snippets/Header2Algo09.rst index 8d83c23..d797086 100644 --- a/doc/en/snippets/Header2Algo09.rst +++ b/doc/en/snippets/Header2Algo09.rst @@ -1,6 +1,6 @@ Python (TUI) use example ++++++++++++++++++++++++ -Here is a very simple use of the given algorithm, written in :ref:`section_tui`, -and from which input information allow to define an equivalent cas in graphical -interface. +Here is a very simple use of the given algorithm and its parameters, written in +:ref:`section_tui`, and from which input information allow to define an +equivalent cas in graphical interface. diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst index 1859627..7f64d13 100644 --- a/doc/fr/ref_algorithm_3DVAR.rst +++ b/doc/fr/ref_algorithm_3DVAR.rst @@ -197,6 +197,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_3DVAR.rst + .. literalinclude:: scripts/simple_3DVAR.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/fr/scripts/simple_3DVAR.rst b/doc/fr/scripts/simple_3DVAR.rst new file mode 100644 index 0000000..1e1f43d --- /dev/null +++ b/doc/fr/scripts/simple_3DVAR.rst @@ -0,0 +1,16 @@ +.. index:: single: 3DVAR (exemple) + +Cet exemple décrit le recalage des paramètres :math:`\mathbf{x}` d'un modèle +d'observation :math:`H` quadratique. Ce modèle est représenté ici comme une +fonction nommée ``QuadFunction``. Cette fonction accepte en entrée le vecteur +de coefficients :math:`\mathbf{x}`, et fournit en sortie le vecteur +:math:`\mathbf{y}` d'évaluation du modèle quadratique aux points de contrôle +internes prédéfinis dans le modèle. Le calage s'effectue sur la base d'un jeu +initial de coefficients (état d'ébauche désigné par ``Xb`` dans l'exemple), et +avec l'information :math:`\mathbf{y}^o` (désignée par ``Yobs`` dans l'exemple) +de 5 mesures obtenues à ces mêmes points de contrôle internes. On privilégie +les observations au détriment de l'ébauche par l'indication d'une très +importante variance d'erreur d'ébauche, ici de :math:`10^{6}`. + +L'ajustement s'effectue en affichant des résultats intermédiaires lors de +l'optimisation itérative. diff --git a/doc/fr/snippets/Header2Algo09.rst b/doc/fr/snippets/Header2Algo09.rst index 6f464a5..bb285ba 100644 --- a/doc/fr/snippets/Header2Algo09.rst +++ b/doc/fr/snippets/Header2Algo09.rst @@ -1,6 +1,6 @@ Exemple d'utilisation en Python (TUI) +++++++++++++++++++++++++++++++++++++ -Voici un exemple très simple d'usage de l'algorithme proposé, écrit en -:ref:`section_tui`, et dont les informations en entrée permettent de définir un -cas équivalent en interface graphique. +Voici un exemple très simple d'usage de l'algorithme proposé et de ses +paramètres, écrit en :ref:`section_tui`, et dont les informations indiquées en +entrée permettent de définir un cas équivalent en interface graphique. -- 2.39.2