From 1ac6d06e6b9993778cc3fde0f589d147d1219c1c Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Sat, 1 Sep 2018 18:49:14 +0200 Subject: [PATCH] Updating documentation for module behavior --- doc/en/advanced.rst | 4 ++-- doc/en/tui.rst | 8 ++++---- doc/fr/advanced.rst | 4 ++-- doc/fr/tui.rst | 8 ++++---- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst index 6a09ea1..bddb4d9 100644 --- a/doc/en/advanced.rst +++ b/doc/en/advanced.rst @@ -217,7 +217,7 @@ the simple example:: library(rPython) python.exec(" from numpy import array - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() case.set( 'AlgorithmParameters', Algorithm='3DVAR' ) case.set( 'Background', Vector=[0, 1, 2] ) @@ -262,7 +262,7 @@ in a R variable. The other lines are identical. The example thus becomes:: python.assign( "h", h ) python.exec(" from numpy import array - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() case.set( 'AlgorithmParameters', Algorithm='3DVAR' ) case.set( 'Background', Vector=xb ) diff --git a/doc/en/tui.rst b/doc/en/tui.rst index ab2af91..aef68ed 100644 --- a/doc/en/tui.rst +++ b/doc/en/tui.rst @@ -55,7 +55,7 @@ order to make the reading easier. The whole set of commands is the following one:: from numpy import array, matrix - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() case.set( 'AlgorithmParameters', Algorithm='3DVAR' ) case.set( 'Background', Vector=[0, 1, 2] ) @@ -84,7 +84,7 @@ commands, the ``case`` object name of the ADAO TUI calculation case being let free to the user choice:: from numpy import array, matrix - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() It is recommended to import by default the ``numpy`` module or some of its @@ -273,7 +273,7 @@ its method "*New()*" as illustrated in the following lines (the ``case`` object name being let free to the user choice):: from numpy import array, matrix - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() It is recommended by default to always import the ``numpy`` module (or some of @@ -619,7 +619,7 @@ observations by simulation in order to set a twin experiments case:: The set of commands that can be used is the following:: import numpy - import adaoBuilder + from adao import adaoBuilder # # Formatting entries # ------------------ diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst index b18b297..9991fb2 100644 --- a/doc/fr/advanced.rst +++ b/doc/fr/advanced.rst @@ -229,7 +229,7 @@ directement issues de l'exemple simple:: library(rPython) python.exec(" from numpy import array - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() case.set( 'AlgorithmParameters', Algorithm='3DVAR' ) case.set( 'Background', Vector=[0, 1, 2] ) @@ -276,7 +276,7 @@ R aussi. Les autres lignes sont identiques. L'exemple devient ainsi:: python.assign( "h", h ) python.exec(" from numpy import array - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() case.set( 'AlgorithmParameters', Algorithm='3DVAR' ) case.set( 'Background', Vector=xb ) diff --git a/doc/fr/tui.rst b/doc/fr/tui.rst index f50e9de..62fd7d5 100644 --- a/doc/fr/tui.rst +++ b/doc/fr/tui.rst @@ -56,7 +56,7 @@ corps du script pour faciliter la lecture. L'ensemble des commandes est le suivant:: from numpy import array, matrix - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() case.set( 'AlgorithmParameters', Algorithm='3DVAR' ) case.set( 'Background', Vector=[0, 1, 2] ) @@ -85,7 +85,7 @@ le nom ``case`` de l'objet du cas de calcul TUI ADAO étant quelconque, au choix de l'utilisateur:: from numpy import array, matrix - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() Il est recommandé d'importer par principe le module ``numpy`` ou ses @@ -284,7 +284,7 @@ méthode "*New()*" comme illustré dans les quelques lignes suivantes (le nom ``case`` de l'objet étant quelconque, au choix de l'utilisateur):: from numpy import array, matrix - import adaoBuilder + from adao import adaoBuilder case = adaoBuilder.New() Il est recommandé par principe de toujours importer le module ``numpy`` (ou ses @@ -644,7 +644,7 @@ observations par simulation pour se placer dans un cas d'expériences jumelles:: Le jeu de commandes que l'on peut utiliser est le suivant:: import numpy - import adaoBuilder + from adao import adaoBuilder # # Mise en forme des entrées # ------------------------- -- 2.39.2