From 3bd32f69cf7bd228f85450994d887387daf9ce82 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 20 Jan 2023 20:27:09 +0100 Subject: [PATCH] Documentation minor update to cite plot support --- doc/en/bibliography.rst | 4 ++++ doc/en/ref_observers_requirements.rst | 8 ++++++++ doc/fr/bibliography.rst | 4 ++++ doc/fr/ref_observers_requirements.rst | 9 +++++++++ 4 files changed, 25 insertions(+) diff --git a/doc/en/bibliography.rst b/doc/en/bibliography.rst index a446d1c..0209a3d 100644 --- a/doc/en/bibliography.rst +++ b/doc/en/bibliography.rst @@ -77,6 +77,10 @@ exhaustive bibliography. .. [Glover90] Glover F., *Tabu Search-Part II*, ORSA Journal on Computing, 2(1), pp.4-32, 1990 +.. [Gnuplot] *Gnuplot - Portable command-line driven graphing utility*, http://www.gnuplot.info/ + +.. [Gnuplot.py] *Gnuplot.py - A pipe-based interface to the gnuplot plotting program*, http://gnuplot-py.sourceforge.net + .. [Gong18] Gong H., *Data assimilation with reduced basis and noisy measurement: Applications to nuclear reactor cores*, PhD Thesis, Sorbonne Université (France), 2018 .. [Hamill00] Hamill T. M., Snyder C., *A Hybrid Ensemble Kalman Filter-3D Variational Analysis Scheme*, Monthly Weather Review, 128(8), pp.2905-2919, 2000 diff --git a/doc/en/ref_observers_requirements.rst b/doc/en/ref_observers_requirements.rst index c38e09c..19b5154 100644 --- a/doc/en/ref_observers_requirements.rst +++ b/doc/en/ref_observers_requirements.rst @@ -126,6 +126,14 @@ user is encouraged to take inspiration from a model that is suitable for him and to modify it by specifying differently this shared information. Then, the modified function can be used in a "*String*" or "*Script*" input. +.. note:: + + Some of the "observers" allow to create figures using the built-in Python + module Gnuplot.py [Gnuplot.py]_, which is an interface to control and send + arguments to the classic graphical plotting utility Gnuplot [Gnuplot]_. + Available under most environments, Gnuplot is independent and must be + correctly preinstalled. Gnuplot.py is here updated to support Python 3. + Hereinafter we give the identifier and the contents of all the available "*observer*" models. diff --git a/doc/fr/bibliography.rst b/doc/fr/bibliography.rst index 1a8fda2..cfa505a 100644 --- a/doc/fr/bibliography.rst +++ b/doc/fr/bibliography.rst @@ -77,6 +77,10 @@ néanmoins d'intention de constituer une bibliographie exhaustive. .. [Glover90] Glover F., *Tabu Search-Part II*, ORSA Journal on Computing, 2(1), pp.4-32, 1990 +.. [Gnuplot] *Gnuplot - Portable command-line driven graphing utility*, http://www.gnuplot.info/ + +.. [Gnuplot.py] *Gnuplot.py - A pipe-based interface to the gnuplot plotting program*, http://gnuplot-py.sourceforge.net + .. [Gong18] Gong H., *Data assimilation with reduced basis and noisy measurement: Applications to nuclear reactor cores*, PhD Thesis, Sorbonne Université (France), 2018 .. [Hamill00] Hamill T. M., Snyder C., *A Hybrid Ensemble Kalman Filter-3D Variational Analysis Scheme*, Monthly Weather Review, 128(8), pp.2905-2919, 2000 diff --git a/doc/fr/ref_observers_requirements.rst b/doc/fr/ref_observers_requirements.rst index b6553b7..ea11784 100644 --- a/doc/fr/ref_observers_requirements.rst +++ b/doc/fr/ref_observers_requirements.rst @@ -136,6 +136,15 @@ s'inspirer d'un modèle lui convenant pour le modifier en spécifiant différemment ces informations communes. Ensuite, la fonction modifiée peut être utilisée dans une entrée de type "*String*" ou de type "*Script*". +.. note:: + + Une partie des "*observer*" permet de créer des figures en utilisant le + module Python intégré Gnuplot.py [Gnuplot.py]_, qui est une interface de + contrôle et transmission d'arguments à l'utilitaire classique de tracé + graphique Gnuplot [Gnuplot]_. Disponible sous la grande majorité des + environnements, ce dernier est indépendant et doit être correctement + préinstallé. Gnuplot.py est ici mis à jour pour supporter Python 3 + On donne ci-après l'identifiant et le contenu de tous les modèles "*observer*" disponibles. -- 2.39.2