Changeset 633 for trunk/docs


Ignore:
Timestamp:
02/11/14 18:12:25 (10 years ago)
Author:
pinsard
Message:

fix thanks to coding rules

Location:
trunk/docs/docs_dev/source
Files:
2 deleted
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/docs/docs_dev/source/conf.py

    r532 r633  
    7070#extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig'] 
    7171extensions = ['sphinx.ext.autodoc', 
    72               'sphinx.ext.doctest', 
    73               'sphinx.ext.todo', 
    74               'sphinx.ext.intersphinx', 
    75               'sphinx.ext.coverage', 
    76               'sphinx.ext.pngmath', 
    77               'sphinx.ext.ifconfig', 
    78               'sphinx.ext.viewcode', 
    79               'sphinx.ext.graphviz', 
    80               'sphinx.ext.inheritance_diagram' ] 
     72          'sphinx.ext.doctest', 
     73          'sphinx.ext.todo', 
     74          'sphinx.ext.intersphinx', 
     75          'sphinx.ext.coverage', 
     76          'sphinx.ext.pngmath', 
     77          'sphinx.ext.ifconfig', 
     78          'sphinx.ext.viewcode', 
     79          'sphinx.ext.graphviz', 
     80          'sphinx.ext.inheritance_diagram' ] 
    8181 
    8282# Add any paths that contain templates here, relative to this directory. 
    … …  
    287287# intersphinx with saxo 
    288288intersphinx_mapping = {'saxo': ('http://forge.ipsl.jussieu.fr/saxo/download/idldoc_html_output/','saxo.inv'), 
    289                 'fptools' : ('http://www.locean-ipsl.upmc.fr/~fplod/fptools/fptools_ws/doc/html/', None)} 
     289        'fptools' : ('http://www.locean-ipsl.upmc.fr/~fplod/fptools/fptools_ws/doc/html/', None)} 

  • trunk/docs/docs_dev/source/guides/bibliography.rst

    r443 r633  
    1414.. 
    1515.. - fplod 20111007T075307Z aedon.locean-ipsl.upmc.fr (Darwin) 
    16 ..  
     16.. 
    1717..   * add [HirdMDermit:RSE:2009] 
    1818.. 

  • trunk/docs/docs_dev/source/guides/builddoc.rst

    r517 r633  
    88.. doxygen 
    99.. 
    10 .. idldoc  
     10.. idldoc 
    1111.. 
    1212.. wiki 
    1313.. 
    1414.. checklink 
    15 ..  
     15.. 
    1616.. EVOLUTIONS 
    1717.. ========== 
    … …  
    4242Documentation |project| 
    4343~~~~~~~~~~~~~~~~~~~~~~~ 
    44 La documentation est construite à partir des fichiers ReStructuredText_  
    45 dans :file:`${PROJECT}/adm/` et des commentaires dans les sources  
     44La documentation est construite à partir des fichiers ReStructuredText_ 
     45dans :file:`${PROJECT}/adm/` et des commentaires dans les sources 
    4646sous :file:`${PROJECT}/src/`. 
    4747 
    … …  
    5454.. parsed-literal:: 
    5555 
    56  $ cd ${|project|}/adm/ 
    57  $ make clean 
    58  $ make before 
    59  $ make html_dev 
     56   cd ${|project|}/adm/ 
     57   make clean 
     58   make before 
     59   make html_dev 
    6060 
    6161et regarder le résultat dans :file:`../doc/html/sphinx/index.html`. 
    6262 
    63 Si le résultat est convainquant, on peut produire les autres formats de  
     63Si le résultat est convainquant, on peut produire les autres formats de 
    6464documentations (HTML single, PDF et troff): 
    6565 
    6666.. parsed-literal:: 
    6767 
    68  $ make all 
     68   make all 
    6969 
    7070Install Documentation |project| 
    … …  
    8080.. parsed-literal:: 
    8181 
    82  $ make install_all 
     82   make install_all 

  • trunk/docs/docs_dev/source/guides/contact.rst

    r443 r633  
    1313.. - fplod 20100603T100421Z aedon.locean-ipsl.upmc.fr (Darwin) 
    1414.. 
    15 ..   * creation  
     15..   * creation 
    1616..     thanks to http://tops.berlios.de/ for the toc and ReSt files 
    1717.. 

  • trunk/docs/docs_dev/source/guides/contents.rst

    r443 r633  
    88.. - fplod 20100603T100421Z aedon.locean-ipsl.upmc.fr (Darwin) 
    99.. 
    10 ..   * creation  
     10..   * creation 
    1111..     thanks to http://tops.berlios.de/ for the toc and ReSt files 
    1212.. 
    … …  
    2525   :maxdepth: 1 
    2626   :glob: 
    27     
     27 
    2828   requirements 
    2929   installing 

  • trunk/docs/docs_dev/source/guides/contributing.rst

    r443 r633  
    3737See :ref:`Contact <contact>` to ask for login or any trouble on your forge.ipsl.jussieu.fr account. 
    3838 
    39 You will find in  
     39You will find in 
    4040:ref:`svn Basic Commands <svnbasiccommands>` how to commit your change 
    4141 

  • trunk/docs/docs_dev/source/guides/data_content.rst

    r545 r633  
    177177 
    178178Here is a recipe to isolate latitude(y), longitude (x) and attribute an unique 
    179 ID for each point for QGIS:: 
    180  
    181  $ for filetxt in /net/zeus/usr/zeus/incas/mousson/LAI/laisen????_float.txt 
     179ID for each point for QGIS: 
     180 
     181.. code-block:: bash 
     182 
     183   for filetxt in /net/zeus/usr/zeus/incas/mousson/LAI/laisen????_float.txt 
    182184   do 
    183185       bfile=$(basename ${filetxt}) 
    … …  
    707709 
    708710.. warning:: 
     711 
    709712   need to belong to ``amma_eu`` group on climserv. 
    710713 
    … …  
    846849This file has been provided by Laurence Eymard. 
    847850 
    848 Following instruction load this file to arrays **Xgco** and **Ygco**:: 
    849  
    850  octave> load('cmgco_traitdecote.mat','Xgco','Ygco'); 
    851  
    852 Plot of the whole world (black dots) can be done like this:: 
    853  
    854  octave> plot(Xgco,Ygco,'k.','MarkerSize',1) 
     851Following instruction load this file to arrays **Xgco** and **Ygco**: 
     852 
     853.. code-block:: matlab 
     854 
     855   load('cmgco_traitdecote.mat','Xgco','Ygco'); 
     856 
     857Plot of the whole world (black dots) can be done like this: 
     858 
     859.. code-block:: matlab 
     860 
     861   plot(Xgco,Ygco,'k.','MarkerSize',1) 
    855862 
    856863.. _zones: 

  • trunk/docs/docs_dev/source/guides/glossary.rst

    r443 r633  
    6969      Global alliance for standard Multi-Purpose Land Cover data production 
    7070      http://www.glcn.org/index_en.jsp 
    71     
    72    CSE  
     71 
     72   CSE 
    7373      Centre de suivi écologique 
    7474 
    75    FAO  
     75   FAO 
    7676      Food and Agriculture organization of United Nations 
    7777 

  • trunk/docs/docs_dev/source/guides/installing.rst

    r443 r633  
    2222:ref:`required software <requirements>` on your system. 
    2323 
    24 You will find in  
     24You will find in 
    2525:ref:`svn Basic Commands <svnbasiccommands>` how to download 
    2626VARAMMA. 

  • trunk/docs/docs_dev/source/guides/read_me.rst

    r443 r633  
    3838programme :ref:`readERA.m`: 
    3939 
    40 :: 
     40.. code-block:: matlab 
    4141 
    42  >> file='CAT.r.2005.2007.6TU.nc'; 
    43  >> z_deb=[ -30 -30 datenum(2005,1,1) 350]; 
    44  >> z_fin=[ 40 40 datenum(2007,12,1) 350]; 
     42   file='CAT.r.2005.2007.6TU.nc'; 
     43   z_deb=[ -30 -30 datenum(2005,1,1) 350]; 
     44   z_fin=[ 40 40 datenum(2007,12,1) 350]; 
    4545 
    4646zone définie par les paramètres début et fin, pour le niveau, il fait la moyenne entre les deux niveaux définis 
    4747 
    48 :: 
     48.. code-block:: matlab 
    4949 
    50  >> chemin='/homedata/eymard/OPERA_Trop/'; 
    51  >> nom_var='r'; 
    52  >> [mat_3D,lat ,lon,date,niveau]=readERA(file,z_deb, z_fin, nom_var,chemin); 
    53  >> [EOF2D,PC]=affiche_EOF_PC_3D(mat_3D,date,lon,lat); 
     50   chemin='/homedata/eymard/OPERA_Trop/'; 
     51   nom_var='r'; 
     52   [mat_3D,lat ,lon,date,niveau]=readERA(file,z_deb, z_fin, nom_var,chemin); 
     53   [EOF2D,PC]=affiche_EOF_PC_3D(mat_3D,date,lon,lat); 
    5454 
    5555options:choix des eof affichés: par défaut 1,2,3 sinon, ajouter [2 3 4] pour les trois suivants 
    … …  
    5757pour changer d'autres paramètres (titre, par ex, regarder :ref:`affiche_eofpc_3Drev.m` pour identifier les variables à ajouter (le titre est le dixième ou à peu près) 
    5858 
    59 Pour sauvegarder la figure en format png:: 
     59Pour sauvegarder la figure en format png: 
    6060 
    61  >> print -dpng figures/nomfig.png 
     61.. code-block:: matlab 
     62 
     63   print -dpng figures/nomfig.png 
    6264 
    6365AMSU 
    6466---- 
    6567 
    66 Avec :ref:`readAMSU.m`, on lit le fichier 2000-2007 par défaut, sinon  
     68Avec :ref:`readAMSU.m`, on lit le fichier 2000-2007 par défaut, sinon 
    6769déclarer le chemin. 
    6870 
    69 on peut aussi définir z_deb et z_fin pour le choix de la zone et la période (en julien comme pour :ref:`readERA.m`):: 
     71on peut aussi définir z_deb et z_fin pour le choix de la zone et la période (en julien comme pour :ref:`readERA.m`): 
    7072 
    71  >> z_deb=[ -30 -30 datenum(2005,1,1)]; 
    72  >> z_fin=[ 40 40 datenum(2008,1,1)]; 
    73  >> nom_var='b3'; 
    74  >> file='b3.2000_2007.nc'; 
    75  >> [mat_3D,jours,latitude ,longitude]=readAMSU(file,z_deb,z_fin); 
     73.. code-block:: matlab 
    7674 
    77 puis lancer:: 
     75   z_deb=[ -30 -30 datenum(2005,1,1)]; 
     76   z_fin=[ 40 40 datenum(2008,1,1)]; 
     77   nom_var='b3'; 
     78   file='b3.2000_2007.nc'; 
     79   [mat_3D,jours,latitude ,longitude]=readAMSU(file,z_deb,z_fin); 
    7880 
    79  >> [EOF2D,PC]=affiche_EOF_PC_3D(mat_3D,jours,longitude,latitude); 
     81puis lancer: 
     82 
     83.. code-block:: matlab 
     84 
     85   [EOF2D,PC]=affiche_EOF_PC_3D(mat_3D,jours,longitude,latitude); 
    8086 
    8187Concernant b5, le problême vient du fait que dans ce canal, il y a des NaN 
    … …  
    8389important dans la région du golfe persique. 
    8490 
    85 Il faut donc refaire une interpolation pour boucher les trous restants :: 
     91Il faut donc refaire une interpolation pour boucher les trous restants : 
    8692 
    87  >> mat_3D_b=boucheNaN_3D(mat_3D); 
     93.. code-block:: matlab 
    8894 
    89 puis refaire le calcul d'eof avec la nouvelle matrice:: 
     95   mat_3D_b=boucheNaN_3D(mat_3D); 
    9096 
    91  >> [EOF2D,PC]=affiche_EOF_PC_3D(mat_3D_b,jours,longitude,latitude); 
     97puis refaire le calcul d'eof avec la nouvelle matrice: 
    9298 
    93 pour calculer des eofs sur une partie de l'année, chaque année, utiliser la fonction :ref:`choix_mois.m`:: 
     99.. code-block:: matlab 
    94100 
    95  >> [mat_3D_s, jours_s]=choix_mois(mat_3D,jours,mois_deb,mois_fin ); 
     101   [EOF2D,PC]=affiche_EOF_PC_3D(mat_3D_b,jours,longitude,latitude); 
     102 
     103pour calculer des eofs sur une partie de l'année, chaque année, utiliser la fonction :ref:`choix_mois.m`: 
     104 
     105.. code-block:: matlab 
     106 
     107   [mat_3D_s, jours_s]=choix_mois(mat_3D,jours,mois_deb,mois_fin ); 
    96108 
    97109puis refaire tourner eof2d avec la bonne entrée. 
    … …  
    102114ex: pour prendre d'avril à août, on choisit mois_deb=4,mois_fin=8 , de décembre a février: mois_deb=12,mois_fin=2, toute l'année (par défaut): mois_deb=1,mois_fin=12 
    103115 
    104 Calcul des eof sans le cycle annuel : fonction:: 
     116Calcul des eof sans le cycle annuel : fonction: 
    105117 
    106  >> [EOF2D,PC]=affiche_EOF_PC_3Dsscycle(mat3D_s,jours,longitude,latitude,titre_fig); 
     118.. code-block:: matlab 
    107119 
     120   [EOF2D,PC]=affiche_EOF_PC_3Dsscycle(mat3D_s,jours,longitude,latitude,titre_fig); 
     121 

  • trunk/docs/docs_dev/source/guides/requirements.rst

    r443 r633  
    7777.. _Matlab: http://www.mathworks.com/ 
    7878 
    79 Matlab should be use as an alternative to octave.  
     79Matlab should be use as an alternative to octave. 
    8080 
    8181Matlab to be completed by NetCDF toolbox/package. 

  • trunk/docs/docs_dev/source/guides/rundemotest.rst

    r630 r633  
    44.. ===== 
    55.. 
    6 .. scons  
     6.. scons 
    77.. 
    88.. dependencies 
    … …  
    4646.. note:: 
    4747 
    48    We do not know yet how to handle source files dependencies so it is  
     48   We do not know yet how to handle source files dependencies so it is 
    4949   up to contributors to define test sequences. 
    5050 
    5151Python 
    5252~~~~~~ 
    53 :: 
    5453 
    55  $ cd ${PROJECT}/src 
    56  $ nosetests --with-doctest -v *.py 
     54.. code-block:: bash 
    5755 
    58 or:: 
     56   cd ${PROJECT}/src 
     57   nosetests --with-doctest -v *.py 
    5958 
    60  $ cd ${PROJECT}/src 
    61  $ coverage -rm -o  *.py 
     59or 
     60 
     61.. code-block:: bash 
     62 
     63   cd ${PROJECT}/src 
     64   coverage -rm -o  *.py 
    6265 
    6366octave 
    6467~~~~~~ 
    6568 
    66 All demos can be launched with one octave command:: 
     69All demos can be launched with one octave command: 
    6770 
    68  $ cd ${PROJECT}/src 
    69  $ octave 
    70  octave> varamma_startup 
     71.. code-block:: bash 
    7172 
    72 .. parsed-literal:: 
     73   cd ${PROJECT}/src 
     74   octave 
    7375 
    74  $ cd ${PROJECT}/src 
    75  $ octave 
    76  octave> demo('module_to_be_demonstrated') 
    77  octave> test('module_to_be_tested') 
     76.. code-block:: matlab 
    7877 
    79 MATLAB  
     78   varamma_startup 
     79 
     80.. code-block:: bash 
     81 
     82   cd ${PROJECT}/src 
     83   octave 
     84 
     85.. code-block:: matlab 
     86 
     87   demo('module_to_be_demonstrated') 
     88   test('module_to_be_tested') 
     89 
     90MATLAB 
    8091~~~~~~ 
    8192 
    8293MATLAB do not understand doctest features like octave. 
    8394 
    84 To run demo and tests, we need first extract doctests from source files:: 
     95To run demo and tests, we need first extract doctests from source files: 
    8596 
    86  $ cd ${PROJECT}/adm 
    87  $ make clean 
    88  $ make before 
    89  $ make matlab_demo 
    90  $ make matlab_test 
     97.. code-block:: bash 
    9198 
    92 Then MATLAB codes for demo and tests are available in  
     99   cd ${PROJECT}/adm 
     100   make clean 
     101   make before 
     102   make matlab_demo 
     103   make matlab_test 
     104 
     105Then MATLAB codes for demo and tests are available in 
    93106:file:`${PROJECT}/adm/demo` and :file:`${PROJECT}/adm/test`. 
    94107 
    … …  
    98111   like in octave ... so tests might not be significant. 
    99112 
    100 To run them:: 
     113To run them: 
    101114 
    102  $ cd ${PROJECT}/src 
    103  $ matlab -nodesktop  
    104  matlab> add_path('../adm/demo') 
    105  matlab> module_to_be_demonstrated_demo 
    106  matlab> add_path('../adm/test') 
    107  matlab> module_to_be_tested_test 
     115 
     116.. code-block:: bash 
     117 
     118   cd ${PROJECT}/src 
     119   matlab -nodesktop 
     120 
     121.. code-block:: matlab 
     122 
     123   add_path('../adm/demo') 
     124   module_to_be_demonstrated_demo 
     125   add_path('../adm/test') 
     126   module_to_be_tested_test 
    108127 
    109128IDL 

  • trunk/docs/docs_dev/source/guides/using.rst

    r443 r633  
    1515 
    1616===== 
    17 Using  
     17Using 
    1818===== 
    19  
    2019 
    2120:ref:`compute EOF <read_me>` 

  • trunk/docs/docs_dev/source/index.rst

    r518 r633  
    33.. EVOLUTIONS 
    44.. ========== 
    5 ..  
     5.. 
    66.. $Id$ 
    77.. 

  • trunk/docs/docs_dev/source/index_guides.rst

    r517 r633  
    4242   guides/installing 
    4343   guides/data_content 
    44    guides/coding_rules 
    4544   guides/rundemotest 
    4645   guides/builddoc 
    … …  
    4948   guides/svnbasiccommands 
    5049   guides/contact 
     50 
     51see also 
     52 
     53:ref:`coding_rules <fptools:coding_rules>` 
     54:ref:`svnbasiccommands <fptools:svnbasiccommands>` 

  • trunk/docs/docs_dev/source/manuals/index.rst

    r516 r633  
    55.. 
    66.. $Id$ 
    7 ..  
     7.. 
    88.. $URL$ 
    99.. 
    … …  
    1515 
    1616.. manuals: 
    17   
     17 
    1818================ 
    1919VARAMMA manuals 
    2020================ 
    21   
     21 
    2222.. toctree:: 
    2323   :maxdepth: 1 
Note: See TracChangeset for help on using the changeset viewer.