From fff8b280648ebafaefa984839a83e351f6869c1e Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Wed, 11 Nov 2020 15:13:25 +0100 Subject: [PATCH] Documentation examples tuning (3) --- doc/en/ref_algorithm_Blue.rst | 2 ++ doc/en/ref_algorithm_ExtendedBlue.rst | 2 ++ doc/en/ref_algorithm_NonLinearLeastSquares.rst | 2 ++ doc/en/scripts/simple_Blue.rst | 9 +++++++++ doc/en/scripts/simple_ExtendedBlue.rst | 9 +++++++++ doc/en/scripts/simple_NonLinearLeastSquares.rst | 14 ++++++++++++++ doc/fr/ref_algorithm_Blue.rst | 2 ++ doc/fr/ref_algorithm_ExtendedBlue.rst | 2 ++ doc/fr/ref_algorithm_NonLinearLeastSquares.rst | 2 ++ doc/fr/scripts/simple_Blue.rst | 9 +++++++++ doc/fr/scripts/simple_ExtendedBlue.rst | 9 +++++++++ doc/fr/scripts/simple_NonLinearLeastSquares.rst | 14 ++++++++++++++ 12 files changed, 76 insertions(+) create mode 100644 doc/en/scripts/simple_Blue.rst create mode 100644 doc/en/scripts/simple_ExtendedBlue.rst create mode 100644 doc/en/scripts/simple_NonLinearLeastSquares.rst create mode 100644 doc/fr/scripts/simple_Blue.rst create mode 100644 doc/fr/scripts/simple_ExtendedBlue.rst create mode 100644 doc/fr/scripts/simple_NonLinearLeastSquares.rst diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst index 73e96d4..28ad983 100644 --- a/doc/en/ref_algorithm_Blue.rst +++ b/doc/en/ref_algorithm_Blue.rst @@ -167,6 +167,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_Blue.rst + .. literalinclude:: scripts/simple_Blue.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst index 5a2b0b7..126cef1 100644 --- a/doc/en/ref_algorithm_ExtendedBlue.rst +++ b/doc/en/ref_algorithm_ExtendedBlue.rst @@ -165,6 +165,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_ExtendedBlue.rst + .. literalinclude:: scripts/simple_ExtendedBlue.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index 953e82b..05ef5bc 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -167,6 +167,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_NonLinearLeastSquares.rst + .. literalinclude:: scripts/simple_NonLinearLeastSquares.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/en/scripts/simple_Blue.rst b/doc/en/scripts/simple_Blue.rst new file mode 100644 index 0000000..458f4d5 --- /dev/null +++ b/doc/en/scripts/simple_Blue.rst @@ -0,0 +1,9 @@ +.. index:: single: Blue (example) + +This example describes the interpolation between two physical states. These two +vector fields, of identical discretization, are the observation +:math:`\mathbf{y}^o` and the background state :math:`\mathbf{x}^b`. The +confidence in errors on the two information are considered identical. The +:math:`H` model fully observe the available field, it is a matrix selection +operator. + diff --git a/doc/en/scripts/simple_ExtendedBlue.rst b/doc/en/scripts/simple_ExtendedBlue.rst new file mode 100644 index 0000000..936fb69 --- /dev/null +++ b/doc/en/scripts/simple_ExtendedBlue.rst @@ -0,0 +1,9 @@ +.. index:: single: ExtendedBlue (example) + +This example describes the interpolation between two physical states. These two +vector fields, of identical discretization, are the observation +:math:`\mathbf{y}^o` and the background state :math:`\mathbf{x}^b`. The +confidence in errors on the two information are considered identical. The +:math:`H` model fully observe the available field, it is a matrix selection +operator. + diff --git a/doc/en/scripts/simple_NonLinearLeastSquares.rst b/doc/en/scripts/simple_NonLinearLeastSquares.rst new file mode 100644 index 0000000..1aefa58 --- /dev/null +++ b/doc/en/scripts/simple_NonLinearLeastSquares.rst @@ -0,0 +1,14 @@ +.. index:: single: NonLinearLeastSquares (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. + +The adjustment is carried out by displaying intermediate results during +iterative optimization. diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index 51d720b..b35e381 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -169,6 +169,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_Blue.rst + .. literalinclude:: scripts/simple_Blue.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index f9db299..995953f 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -166,6 +166,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_ExtendedBlue.rst + .. literalinclude:: scripts/simple_ExtendedBlue.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index c32e8bb..8fced14 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -170,6 +170,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo09.rst +.. include:: scripts/simple_NonLinearLeastSquares.rst + .. literalinclude:: scripts/simple_NonLinearLeastSquares.py .. include:: snippets/Header2Algo10.rst diff --git a/doc/fr/scripts/simple_Blue.rst b/doc/fr/scripts/simple_Blue.rst new file mode 100644 index 0000000..97f5167 --- /dev/null +++ b/doc/fr/scripts/simple_Blue.rst @@ -0,0 +1,9 @@ +.. index:: single: Blue (exemple) + +Cet exemple décrit l'interpolation entre deux états physiques. Ces deux champs +vectoriels, de discrétisation identique, sont l'observation +:math:`\mathbf{y}^o` et l'état d'ébauche a priori :math:`\mathbf{x}^b`. Les +confiances dans les erreurs sur les deux informations sont considérées comme +identiques. Le modèle :math:`H` observe complètement le champ disponible, c'est +un opérateur de sélection matriciel. + diff --git a/doc/fr/scripts/simple_ExtendedBlue.rst b/doc/fr/scripts/simple_ExtendedBlue.rst new file mode 100644 index 0000000..ab66c00 --- /dev/null +++ b/doc/fr/scripts/simple_ExtendedBlue.rst @@ -0,0 +1,9 @@ +.. index:: single: ExtendedBlue (exemple) + +Cet exemple décrit l'interpolation entre deux états physiques. Ces deux champs +vectoriels, de discrétisation identique, sont l'observation +:math:`\mathbf{y}^o` et l'état d'ébauche a priori :math:`\mathbf{x}^b`. Les +confiances dans les erreurs sur les deux informations sont considérées comme +identiques. Le modèle :math:`H` observe complètement le champ disponible, c'est +un opérateur de sélection matriciel. + diff --git a/doc/fr/scripts/simple_NonLinearLeastSquares.rst b/doc/fr/scripts/simple_NonLinearLeastSquares.rst new file mode 100644 index 0000000..32bf45a --- /dev/null +++ b/doc/fr/scripts/simple_NonLinearLeastSquares.rst @@ -0,0 +1,14 @@ +.. index:: single: NonLinearLeastSquares (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. + +L'ajustement s'effectue en affichant des résultats intermédiaires lors de +l'optimisation itérative. -- 2.39.2