Changeset 203 for trunk/docs


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

fix thanks to coding rules

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

Legend:

Unmodified
Added
Removed
  • trunk/docs/docs_dev/source/guides/bibliography.rst

    r198 r203  
    2929.. - fplod 20110622T155451Z aedon.locean-ipsl.upmc.fr (Darwin) 
    3030.. 
    31 ..   * remove kumarVialard to avoid redondancies between this bibligraphy and  
     31..   * remove kumarVialard to avoid redondancies between this bibligraphy and 
    3232..     the web site one. same for LiebmannSmith:BAMS:1996 
    3333.. 
     
    6666.. [BourlesLumpkinEtAL:BAMS:2008] Bourlès, B., Lumpkin, R., McPhaden, M. J., Hernandez, F., Nobre, P., Campos, E., Yu, L. S., Planton, S., Busalacchi, A., Moura, A. D., Servain, J. and Trotte, J. *The PIRATA program : history, accomplishments, and future directions*, Bulletin of the American Meteorological Society, 2008, Vol. 89(8), pp. 1111-1125, http://dx.doi.org/10.1175/2008BAMS2462.1 
    6767 
    68 .. [McPhadenMeyersEtAl:BAMS:2009] McPhaden, M. J., G. Meyers, K. Ando,Y. Masumoto, V. S. N. Murty, M. Ravichandran,  
    69 F. Syamsudin, J. Vialard, L. Yu, and W. Yu, 2009: RAMA: The Research Moored Array for African-Asian-Australian Monso 
    70 on Analysis and Prediction. Bull. Am. Meteorol. Soc., 90, 459-480, doi:10.1175/2008BAMS2608.1 
     68.. [McPhadenMeyersEtAl:BAMS:2009] McPhaden, M. J., G. Meyers, K. Ando,Y. Masumoto, V. S. N. Murty, M. Ravichandran, F. Syamsudin, J. Vialard, L. Yu, and W. Yu, 2009: RAMA: The Research Moored Array for African-Asian-Australian Monso on Analysis and Prediction. Bull. Am. Meteorol. Soc., 90, 459-480, doi:10.1175/2008BAMS2608.1 
    7169 
    72 .. [McPhadenBusalacchiEtAL:JGR:1998] McPhaden, M.J., A.J. Busalacchi, R. Cheney, J.R. Donguy, K.S. Gage, D. Halpern, 
    73  M. Ji, P. Julian, G. Meyers, G.T. Mitchum, P.P. Niiler, J. Picaut, R.W. Reynolds, N. Smith, K. Takeuchi, 1998: The  
    74 Tropical Ocean-Global Atmosphere (TOGA) observing system: A decade of progress. J. Geophys. Res., 103, 14, 169-14,24 
     70.. [McPhadenBusalacchiEtAL:JGR:1998] McPhaden, M.J., A.J. Busalacchi, R. Cheney, J.R. Donguy, K.S. Gage, D. Halpern, M. Ji, P. Julian, G. Meyers, G.T. Mitchum, P.P. Niiler, J. Picaut, R.W. Reynolds, N. Smith, K. Takeuchi, 1998: The Tropical Ocean-Global Atmosphere (TOGA) observing system: A decade of progress. J. Geophys. Res., 103, 14, 169-14,24 
    75710. 
    7672 
  • trunk/docs/docs_dev/source/guides/builddoc.rst

    r199 r203  
    88.. SEE ALSO 
    99.. ======== 
    10 ..  
     10.. 
    1111.. :ref:`Makefile` 
    12 ..  
     12.. 
    1313.. TODO 
    1414.. ===== 
     
    8686.. _Sphinx: http://sphinx.pocoo.org/ 
    8787 
    88 .. parsed-literal:: 
     88.. code-block:: bash 
    8989 
    90    $ cd ${PROJECT}/adm/ 
    91    $ make clean 
    92    $ make before 
    93    $ make html_dev_sphinx 
     90   cd ${PROJECT}/adm/ 
     91   make clean 
     92   make before 
     93   make html_dev_sphinx 
    9494 
    9595et regarder le résultat dans :file:`../doc/html/index.html`. 
     
    9898documentations (HTML single, PDF et troff): 
    9999 
    100 .. parsed-literal:: 
     100.. code-block:: bash 
    101101 
    102    $ make all_dev 
     102   make all_dev 
    103103 
    104104Website |project| 
     
    112112.. parsed-literal:: 
    113113 
    114    $ cd ${PROJECT}/adm/ 
    115    $ make clean 
    116    $ make before 
    117    $ make html_user 
     114   cd ${PROJECT}/adm/ 
     115   make clean 
     116   make before 
     117   make html_user 
    118118 
    119119et regarder le résultat dans :file:`./website/_build/html/index.html`. 
     
    131131.. parsed-literal:: 
    132132 
    133    $ make install_all 
     133   make install_all 
  • trunk/docs/docs_dev/source/guides/contact.rst

    r110 r203  
    1010.. - fplod 20101220T115124Z aedon.locean-ipsl.upmc.fr (Darwin) 
    1111.. 
    12 ..   * creation  
     12..   * creation 
    1313.. 
    1414.. - 
  • trunk/docs/docs_dev/source/guides/data_content.rst

    r199 r203  
    88.. section title by variable or by provider ... 
    99.. 
    10 .. http://data-portal.ecmwf.int/data/d/interim_full_daily  
     10.. http://data-portal.ecmwf.int/data/d/interim_full_daily 
    1111.. Pour sst : 
    1212.. select all time : 0,6, 12,  18 
     
    152152^^^^^^^ 
    153153 
    154 oaflux isccp  
     154oaflux isccp 
    155155 
    156156Documentation 
  • trunk/docs/docs_dev/source/guides/generate_tropflux.rst

    r199 r203  
    114114 
    115115There's also one additional step to convert ERA-I dewpoint T :math:`d_{2m}` into specific humidity :math:`q_{2m}` : 
    116   
     116 
    117117 - :func:`d2m_to_q2m_erai` (:func:`rh_to_spechum`, :func:`qsat`) 
    118118 
     
    148148tools : 
    149149 - :func:`cronin_gustiness_ncdf` 
    150  - :func:`tropflux` (:func:`cor30a`), :func:`tropflux_nrt_ncdf`  
     150 - :func:`tropflux` (:func:`cor30a`), :func:`tropflux_nrt_ncdf` 
    151151 
    152152After that step, there are 5 files: Tropflux :math:`T_{2m}`, :math:`q_{2m}`, SST, wind, and one file with the 4 components of the net flux (sensible, latent, SWR, LWR) 
     
    155155.. math:`T_{2m}`, :math:`q_{2m}`, SST, wind, swr and lwr came from correction mooring 
    156156.. final wind product is not corrected for wind gustiness. 
    157 .. sensible, latent shf and lhf came from coare correction  
     157.. sensible, latent shf and lhf came from coare correction 
    158158 
    159159.. _momentum_fluxes: 
  • trunk/docs/docs_dev/source/guides/glossary.rst

    r110 r203  
    2323      ERA-INTERIM 
    2424 
    25       http://www.ecmwf.int/research/era/do/get/era-interim  
     25      http://www.ecmwf.int/research/era/do/get/era-interim 
    2626 
    2727   ECMWF 
  • trunk/docs/docs_dev/source/guides/history.rst

    r110 r203  
    2222======= 
    2323 
    24 TropFlux project started in mid 2008 as joint research collaboration  
    25 between National Institute of Oceanography (NIO, CSIR), India, and  
    26 Institut Pierre Simon Laplace (IPSL), Paris.   
    27 TropFlux project aims at producing daily, timely, high quality air-sea fluxes over the global tropical ocean belt (30N-30S).  Presently, it is available on  
    28 a 1 x 1 degree grid from 1989-2009.  Eventually, we hope to update these fluxes  
    29 routinely about 3-4 months behind realtime.  
     24TropFlux project started in mid 2008 as joint research collaboration 
     25between National Institute of Oceanography (NIO, CSIR), India, and 
     26Institut Pierre Simon Laplace (IPSL), Paris. 
     27TropFlux project aims at producing daily, timely, high quality air-sea fluxes over the global tropical ocean belt (30N-30S).  Presently, it is available on 
     28a 1 x 1 degree grid from 1989-2009.  Eventually, we hope to update these fluxes 
     29routinely about 3-4 months behind realtime. 
    3030 
    31 The air-sea fluxes are largely derived from ERA-interim re-analysis (see  
    32 http://www.ecmwf.int/research/era/do/get/era-interim for details) and  
    33 ISCCP project (http://isccp.giss.nasa.gov/) shortwave fluxes with ad hoc  
    34 corrections derived from the tropical moored buoy array.  
    35 See the reference below (available in this directory as  
    36 https://www.locean-ipsl.upmc.fr/~jv/data/TropFlux_Climate_Dynamics_r.pdf) for  
    37 more details.  
    38   
    39  
     31The air-sea fluxes are largely derived from ERA-interim re-analysis (see 
     32http://www.ecmwf.int/research/era/do/get/era-interim for details) and 
     33ISCCP project (http://isccp.giss.nasa.gov/) shortwave fluxes with ad hoc 
     34corrections derived from the tropical moored buoy array. 
     35See the reference below (available in this directory as 
     36https://www.locean-ipsl.upmc.fr/~jv/data/TropFlux_Climate_Dynamics_r.pdf) for 
     37more details. 
  • trunk/docs/docs_dev/source/guides/updatedata.rst

    r201 r203  
    135135.. parsed-literal:: 
    136136 
    137    $ datemodif="20120209" 
    138  
    139    $ export datemodif 
    140    $ cd /usr/lodyc/incas/fplod/tropflux_d/ 
    141    $ mkdir obsolete_${datemodif} 
    142  
    143 .. parsed-literal:: 
    144  
    145    $ mv Readme.rst obsolete_${datemodif} 
    146    $ mv ./daily obsolete_${datemodif} 
    147    $ mv ./monthly obsolete_${datemodif} 
     137   datemodif="20120209" 
     138 
     139   export datemodif 
     140   cd /usr/lodyc/incas/fplod/tropflux_d/ 
     141   mkdir obsolete_${datemodif} 
     142 
     143.. parsed-literal:: 
     144 
     145   mv Readme.rst obsolete_${datemodif} 
     146   mv ./daily obsolete_${datemodif} 
     147   mv ./monthly obsolete_${datemodif} 
    148148 
    149149.. _copynew1: 
     
    154154.. parsed-literal:: 
    155155 
    156    $ newdir='/net/adonis/usr/adonis/varclim/tropflux_v1' 
    157    $ export newdir 
    158    $ svn export svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/tropflux/svn/trunk/adm/website/Readme.rst \ 
    159      /usr/lodyc/incas/fplod/tropflux_d/to_be_published/Readme.rst 
    160    $ cp -r ${newdir}/daily /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    161    $ cp -r ${newdir}/monthly /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     156   newdir='/net/adonis/usr/adonis/varclim/tropflux_v1' 
     157   export newdir 
     158   svn export svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/tropflux/svn/trunk/adm/website/Readme.rst \ 
     159   /usr/lodyc/incas/fplod/tropflux_d/to_be_published/Readme.rst 
     160   cp -r ${newdir}/daily /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     161   cp -r ${newdir}/monthly /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    162162 
    163163.. _compareversion: 
     
    172172.. parsed-literal:: 
    173173 
    174    $ ++compare.sh -o obsolete_${datemodif} -n /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     174   ++compare.sh -o obsolete_${datemodif} -n /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    175175 
    176176Once comparison is done and PI happy, 
     
    184184.. parsed-literal:: 
    185185 
    186    $ cd /usr/lodyc/incas/fplod/tropflux_d/ 
    187    $ mv ./to_be_published/Readme.rst . 
    188    $ mv ./to_be_published/daily ./ 
    189    $ mv ./to_be_published/monthly ./ 
    190    $ ln -sf $(pwd)/Readme.rst daily/ 
    191    $ ln -sf $(pwd)/Readme.rst monthly/ 
     186   cd /usr/lodyc/incas/fplod/tropflux_d/ 
     187   mv ./to_be_published/Readme.rst . 
     188   mv ./to_be_published/daily ./ 
     189   mv ./to_be_published/monthly ./ 
     190   ln -sf $(pwd)/Readme.rst daily/ 
     191   ln -sf $(pwd)/Readme.rst monthly/ 
    192192 
    193193 
     
    235235   .. parsed-literal:: 
    236236 
    237       $ diskext="/Volumes/LCerbere" 
    238       $ mkdir ${diskext} 
    239       $ sshfs fplod@cerbere:/usr/lodyc/incas/fplod ${diskext} -odefer_permissions -o sshfs_debug 
     237      diskext="/Volumes/LCerbere" 
     238      mkdir ${diskext} 
     239      sshfs fplod@cerbere:/usr/lodyc/incas/fplod ${diskext} -odefer_permissions -o sshfs_debug 
    240240 
    241241.. _advertise: 
  • trunk/docs/docs_dev/source/guides/updatedata/updatedata_20130725.rst

    r202 r203  
    4545:file:`${PROJECT}/adm/website/data_access.rst` 
    4646:file:`${PROJECT}/adm/website/overview.rst` 
    47 :file:`${PROJECT}/adm/website/Readme.rst`  
     47:file:`${PROJECT}/adm/website/Readme.rst` 
    4848:file:`${PROJECT}/adm/website/_templates/layout.html` 
    4949 
     
    5555.. parsed-literal:: 
    5656 
    57    $ datemodif="20130725" 
    58  
    59    $ export datemodif 
    60    $ cd /usr/lodyc/incas/fplod/tropflux_d/ 
    61    $ mkdir obsolete_${datemodif} 
    62  
    63 .. parsed-literal:: 
    64  
    65    $ mv Readme.rst obsolete_${datemodif} 
    66    $ mv ./daily obsolete_${datemodif} 
    67    $ mv ./monthly obsolete_${datemodif} 
     57   datemodif="20130725" 
     58 
     59   export datemodif 
     60   cd /usr/lodyc/incas/fplod/tropflux_d/ 
     61   mkdir obsolete_${datemodif} 
     62 
     63.. parsed-literal:: 
     64 
     65   mv Readme.rst obsolete_${datemodif} 
     66   mv ./daily obsolete_${datemodif} 
     67   mv ./monthly obsolete_${datemodif} 
    6868 
    6969.. _copynew1_20130725: 
     
    7474.. parsed-literal:: 
    7575 
    76    $ mkdir /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    77    $ newdir='/net/adonis/usr/adonis/varclim/tropflux_v2' 
    78    $ export newdir 
     76   mkdir /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     77   newdir='/net/adonis/usr/adonis/varclim/tropflux_v2' 
     78   export newdir 
    7979 
    8080Is there enought space ? 
    8181 
    82 :: 
    83  
    84    $ du -sh ${newdir}/daily 
     82.. parsed-literal:: 
     83 
     84   du -sh ${newdir}/daily 
    8585   12G     /net/adonis/usr/adonis/varclim/tropflux_v2/daily 
    86    $ du -sh ${newdir}/monthly 
     86   du -sh ${newdir}/monthly 
    8787   396M    /net/adonis/usr/adonis/varclim/tropflux_v2/monthly 
    88    $ df -h /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     88   df -h /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    8989   Filesystem            Size  Used Avail Use% Mounted on 
    9090   fslodyc:/usr/.lodyc   1.6T  1.6T   20G  99% /.autofs/lodyc 
     
    929220GB vs 12.4 GB = yes 
    9393 
    94 then, copy :: 
    95  
    96    $ cp ${PROJECT}/adm/website/Readme.rst /usr/lodyc/incas/fplod/tropflux_d/to_be_published/Readme.rst 
    97    $ cp -r ${newdir}/daily /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    98    $ cp -r ${newdir}/monthly /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     94then, copy : 
     95 
     96.. parsed-literal:: 
     97 
     98   cp ${PROJECT}/adm/website/Readme.rst /usr/lodyc/incas/fplod/tropflux_d/to_be_published/Readme.rst 
     99   cp -r ${newdir}/daily /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
     100   cp -r ${newdir}/monthly /usr/lodyc/incas/fplod/tropflux_d/to_be_published 
    99101 
    100102.. _compareversion_20130725: 
     
    108110see draft tool :ref:`compare.sh` 
    109111 
    110 :: 
     112.. parsed-literal:: 
    111113 
    112114   log=${PROJECT_LOG}/compare.log 
     
    119121First check expected equality for data: 
    120122 
    121 :: 
     123.. parsed-literal:: 
    122124 
    123125   grep "records differ" ${log} 
     
    130132On creation_date 
    131133 
    132 :: 
     134.. parsed-literal:: 
    133135 
    134136   grep "^>" ${log} | grep creation_date 
     
    138140It is what happened in this 20130725 data update, so: 
    139141 
    140 :: 
     142.. parsed-literal:: 
    141143 
    142144   change_creation_date.sh -d /usr/lodyc/incas/fplod/tropflux_d/to_be_published/ -c 20130725 
     
    145147 
    146148On time_range 
    147 :: 
     149 
     150.. parsed-literal:: 
    148151 
    149152   grep "^>" ${log} | grep time_range 
    150153 
     154 
     155 
    151156If nothing appears, you must modified this attributes. see :ref:`change_time_range.sh` 
    152157 
    153 It is what happened in this 20130725 data update, so:: 
     158It is what happened in this 20130725 data update, so: 
     159 
     160.. parsed-literal:: 
    154161 
    155162   change_time_range.sh -d /usr/lodyc/incas/fplod/tropflux_d/to_be_published/ -b 19790101 -e 20130331 
     163 
    156164   tlogd.sh change_time_range 
    157165 
    158 Clean comparison log file:: 
     166Clean comparison log file: 
     167 
     168.. parsed-literal:: 
    159169 
    160170   rm ${log} 
     
    162172Correct terminology if still necessary: 
    163173 
    164 :: 
    165  
    166   correct_terminology.sh -d /usr/lodyc/incas/fplod/tropflux_d/to_be_published/ -good "1979_2013" -bad "1979_march2013" 
    167   tlogd.sh correct_terminology 
     174.. parsed-literal:: 
     175 
     176   correct_terminology.sh -d /usr/lodyc/incas/fplod/tropflux_d/to_be_published/ -good "1979_2013" -bad "1979_march2013" 
     177   tlogd.sh correct_terminology 
    168178 
    169179If modifications has been made, re-run comparison (go back to 
     
    181191.. parsed-literal:: 
    182192 
    183    $ cd /usr/lodyc/incas/fplod/tropflux_d/ 
    184    $ mv ./to_be_published/Readme.rst . 
    185    $ mv ./to_be_published/daily ./ 
    186    $ mv ./to_be_published/monthly ./ 
    187    $ ln -sf $(pwd)/Readme.rst daily/ 
    188    $ ln -sf $(pwd)/Readme.rst monthly/ 
    189  
     193   cd /usr/lodyc/incas/fplod/tropflux_d/ 
     194   mv ./to_be_published/Readme.rst . 
     195   mv ./to_be_published/daily ./ 
     196   mv ./to_be_published/monthly ./ 
     197   ln -sf $(pwd)/Readme.rst daily/ 
     198   ln -sf $(pwd)/Readme.rst monthly/ 
    190199 
    191200.. _desinstalldata_20130725: 
     
    242251 
    243252 
    244 Files in :file:`${PROJECT}/adm/website/` have been modified to tell the new time coverage so  
     253Files in :file:`${PROJECT}/adm/website/` have been modified to tell the new time coverage so 
    245254see also :ref:`builddoc` to synchronize dataset and documentation 
    246255 
  • trunk/docs/docs_dev/source/guides/updatepapers.rst

    r117 r203  
    7272      fplod@sonmac$ ftp www.locean-ipsl.upmc.fr 
    7373      ftp> cd |project_id| 
    74       ftp> mkdir papers  
     74      ftp> mkdir papers 
    7575 
    7676La mise à disposition des fichiers de données, des papiers et des images sur l'URL 
     
    8181.. _savepaper: 
    8282 
    83 Save papers  
     83Save papers 
    8484----------- 
    8585 
    8686.. parsed-literal:: 
    8787 
    88    $ paper=~/Downloads/tropflux_clivar_final_acc.pdf  
    89    $ export paper 
    90    $ mv ${paper}/usr/lodyc/incas/fplod/tropflux_d/papers/ 
     88   paper=~/Downloads/tropflux_clivar_final_acc.pdf 
     89   export paper 
     90   mv ${paper}/usr/lodyc/incas/fplod/tropflux_d/papers/ 
    9191 
    9292Installation of the papers 
     
    108108   .. parsed-literal:: 
    109109 
    110       $ diskext="/Volumes/LCerbere" 
    111       $ sshfs fplod@cerbere:/usr/lodyc/incas/fplod ${diskext} -odefer_permissions 
     110      diskext="/Volumes/LCerbere" 
     111      sshfs fplod@cerbere:/usr/lodyc/incas/fplod ${diskext} -odefer_permissions 
    112112 
    113113.. _biblio: 
  • trunk/docs/docs_dev/source/index_guides.rst

    r199 r203  
    4343   guides/updatepapers 
    4444   guides/builddoc 
    45    guides/coding_rules 
    4645 
    4746.. +todo+   guides/requirements 
     
    4948.. +todo+   guides/using 
    5049.. +todo+   guides/contributing 
     50 
     51 
     52see also 
     53:ref:`coding_rules <fptools:coding_rules>` 
  • trunk/docs/docs_dev/source/manuals/index.rst

    r199 r203  
    55.. 
    66.. $Id$ 
    7 ..  
     7.. 
    88.. $URL$ 
    99.. 
     
    1515 
    1616.. manuals: 
    17   
     17 
    1818================ 
    1919TROPFLUX manuals 
    2020================ 
    21   
     21 
    2222.. toctree:: 
    2323   :maxdepth: 1 
  • trunk/docs/docs_dev/source/manuals/manuals_python.rst

    r199 r203  
    44.. ==== 
    55.. 
    6 .. see https://bitbucket.org/etienned/sphinx-autopackage-script/src/7199e9725789/generate_modules.py to automate  
     6.. see https://bitbucket.org/etienned/sphinx-autopackage-script/src/7199e9725789/generate_modules.py to automate 
    77.. 
    88.. EVOLUTIONS 
Note: See TracChangeset for help on using the changeset viewer.