Changeset 4

Timestamp:

12/13/10 17:36:08 (13 years ago)

Author:

pinsard

Message:

add .sh extension to shell scripts; minimal header; complete data guide

Location:

trunk

Files:

• adm/guides/data_content.rst (modified) (3 diffs)
• adm/guides/generate_statistics.rst (modified) (1 diff)
• adm/guides/generate_tropflux.rst (modified) (2 diffs)
• adm/sphinx/conf.py (modified) (2 diffs)
• src/get_olr.sh (moved) (moved from trunk/src/get_olr) (1 diff)
• src/get_olrnint.sh (moved) (moved from trunk/src/get_olrnint) (1 diff)
• src/get_pirata_netcdf.sh (moved) (moved from trunk/src/get_pirata_netcdf) (2 diffs)
• src/get_rama_netcdf.sh (moved) (moved from trunk/src/get_rama_netcdf) (1 diff)
• src/get_tao_netcdf.sh (moved) (moved from trunk/src/get_tao_netcdf) (2 diffs)

trunk/adm/guides/data_content.rst

@@ -3 +3 @@
 .. EVOLUTIONS
 .. ==========
+..
+.. - fplod 20101213T161512Z aedon.locean-ipsl.upmc.fr (Darwin)
+..
+..   * add data_in section
 ..
 .. - fplod 20101208T163033Z aedon.locean-ipsl.upmc.fr (Darwin)
@@ -21 +25 @@
 
 contenu terminologie granulométrie organisation etc.
+
+.. _data_in:
+
+Input data
+----------
+
+.. _data_in_olr:
+
+OLR
+~~~
+
+Interpolated
+++++++++++++
+
+:file:`ftp://ftp.cdc.noaa.gov/Datasets/interp_OLR/olr.day.mean.nc`
+
+:ref:`get_olr.sh`
+
+Uninterpolated
+++++++++++++++
+
+:file:`ftp://ftp.cdc.noaa.gov/Datasets/uninterp_OLR/olr.day.mean.nc`
+
+:ref:`get_olrnint.sh`
+
+.. _data_in_pirata:
+
+PIRATA
+~~~~~~
+
+URL : +todo+
+
+list of variables : +todo+
+
+list of sites : +todo+
+
+:ref:`get_pirata_netcdf.sh`
+
+.. _data_in_rama:
+
+RAMA
+~~~~
+
+URL : +todo+
+
+list of variables : +todo+
+
+list of sites : +todo+
+
+:ref:`get_rama_netcdf.sh`
+
+TAO
+~~~
+
+.. _data_in_tao:
+
+URL : +todo+
+
+list of variables : +todo+
+
+list of sites : +todo+
+
+:ref:`get_tao_netcdf.sh`
 
 .. _data_out:
@@ -73 +140 @@
 
 This file contains Tropflux corrected wind speed at 10m above the sea surface.
-The <quote>gustiness</quote> correction applied to wind speed for turbulent heat flux
+The "gustiness" correction applied to wind speed for turbulent heat flux
 computations (see paper +todo+link for details) is not applied in
 this file.

trunk/adm/guides/generate_statistics.rst

@@ -26 +26 @@
 Getting RAMA / TAO / PIRATA data
 
-  tools
-     :ref:`get_rama_netcdf.sh`
-     :ref:`get_tao_netcdf.sh`
-     :ref:`get_pirata_netcdf.sh`
+tools:
+ - :ref:`get_rama_netcdf.sh`
+ - :ref:`get_tao_netcdf.sh`
+ - :ref:`get_pirata_netcdf.sh`
 
 

trunk/adm/guides/generate_tropflux.rst

@@ -28 +28 @@
 Gather data
 -----------
+
 ERA-I data 
     (wind components at 10m, air temperature at 2m, dewpoint temperature at 2m, net SW, net LW)
@@ -44 +45 @@
    get NOAA interpolated and uninterpolated OLR data
 
-   tools
-      :ref:`get_olr.sh`
-      :ref:`get_olrnint.sh`
+   tools:
+    - :ref:`get_olr.sh`
+    - :ref:`get_olrnint.sh`
 
 Interpolate datasets onto the OAFLUX grid

trunk/adm/sphinx/conf.py

@@ -23 +23 @@
 # EVOLUTIONS
 # ==========
+#
+# - fplod 20101213T163131Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * add hard coded manual pages (get_*.sh)
 #
 # - fplod 20101213T150221Z aedon.locean-ipsl.upmc.fr (Darwin)
@@ -244 +248 @@
     ('elogd.sh', 'elogd.sh', u'elogd.sh Documentation', [u'IRD'], 1),
     ('plogd.sh', 'plogd.sh', u'plogd.sh Documentation', [u'IRD'], 1),
-    ('tlogd.sh', 'tlogd.sh', u'tlogd.sh Documentation', [u'IRD'], 1)
+    ('tlogd.sh', 'tlogd.sh', u'tlogd.sh Documentation', [u'IRD'], 1),
+    ('get_olr.sh', 'get_olr.sh', u'get_olr.sh Documentation', [u'IRD'], 1),
+    ('get_olrnint.sh', 'get_olrnint.sh', u'get_olrnint.sh Documentation', [u'IRD'], 1),
+    ('get_pirata_netcdf.sh', 'get_pirata_netcdf.sh', u'get_pirata_netcdf.sh Documentation', [u'IRD'], 1),
+    ('get_rama_netcdf.sh', 'get_rama_netcdf.sh', u'get_rama_netcdf.sh Documentation', [u'IRD'], 1),
+    ('get_tao_netcdf.sh', 'get_tao_netcdf.sh', u'get_tao_netcdf.sh Documentation', [u'IRD'], 1)
 ]

trunk/src/get_olr.sh

@@ -1 @@
-#!/bin/sh
-
+#! /bin/sh
+#+
+#
+# .. program:: get_olr.sh
+#
+# .. _get_olr.sh:
+#
+# =================================================
+# get_olr.sh -- get OLR interpolated reference file
+# =================================================
+# 
+# SYNOPSIS
+# ========
+#
+# ::
+#
+#  $ get_olr.sh
+#
+# DESCRIPTION
+# ===========
+#
+# ``get_olr.sh`` get OLR interpolated reference file
+#
+# SEE ALSO
+# ========
+#
+# :ref:`guide data OLR <data_in_olr>`
+#
+# :ref:`get_olrnint.sh`
+#
+# TODO
+# ====
+#
+# trace
+#
+# hard coded directory - usage of ${TROPFLUX_ID}
+#
+# coding rules
+#
+# EVOLUTIONS
+# ==========
+#
+# - fplod 20101213T155858Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * minimal header
+#
+# - jv 2008
+#
+#   * creation
+#
+#-
 DIR_DATA='/Users/jv/data/OLR/'
 

trunk/src/get_olrnint.sh

@@ +1 @@
+#! /bin/sh
+#+
+#
+# .. program:: get_olrnint.sh
+#
+# .. _get_olrnint.sh:
+#
+# =======================================================
+# get_olrnint.sh -- get OLR uninterpolated reference file
+# =======================================================
+#
+#
+# SYNOPSIS
+# ========
+#
+# ::
+#
+#  $ get_olrnint.sh
+#
+# DESCRIPTION
+# ===========
+#
+# ``get_olrnint.sh`` get OLR uninterpolated reference file
+#
+# SEE ALSO
+# ========
+#
+# :ref:`guide data OLR <data_in_olr>`
+#
+# :ref:`get_olr.sh`
+#
+# TODO
+# ====
+#
+# trace
+#
+# hard coded directory - usage of ${TROPFLUX_ID}
+#
+# coding rules
+#
+# EVOLUTIONS
+# ==========
+#
+# - fplod 20101213T160042Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * minimal header
+#
+# - jv 2008
+#
+#   * creation
+#
+#-
+
 wget ftp://ftp.cdc.noaa.gov/Datasets/uninterp_OLR/olr.day.mean.nc
 mv olr.day.mean.nc olr_nint.day.mean.nc

trunk/src/get_pirata_netcdf.sh

@@ -1 @@
-#!/bin/sh
-
+#! /bin/sh
+#+
+#
+# .. program:: get_pirata_netcdf.sh
+#
+# .. _get_pirata_netcdf.sh:
+#
+# ==================================================
+# get_pirata_netcdf.sh -- get PIRATA reference files
+# ==================================================
+#
+# 
+# SYNOPSIS
+# ========
+#
+# ::
+#
+#  $ get_pirata_netcdf.sh
+#
+# DESCRIPTION
+# ===========
+#
+# ``get_pirata_netcdf.sh`` get PIRATA reference files
+#
+# SEE ALSO
+# ========
+#
+# :ref:`guide data PIRATA <data_in_pirata>`
+#
+# TODO
+# ====
+#
+# trace
+#
+# hard coded directory - usage of ${TROPFLUX_ID}
+#
+# coding rules
+#
+# EVOLUTIONS
+# ==========
+#
+# - fplod 20101213T160729Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * minimal header
+#
+# - jv 2008
+#
+#   * creation
+#
+#-
 dir=/Users/jv/data/PIRATA/data/
 
@@ -29 +77 @@
 
 ls -l
-
-#

trunk/src/get_rama_netcdf.sh

@@ -1 @@
-#!/bin/sh
+#! /bin/sh
+#+
+#
+# .. program:: get_rama_netcdf.sh
+#
+# .. _get_rama_netcdf.sh:
+#
+# ==============================================
+# get_rama_netcdf.sh -- get RAMA reference files
+# ==============================================
+#
+#
+# SYNOPSIS
+# ========
+#
+# ::
+#
+#  $ get_rama_netcdf.sh
+#
+# DESCRIPTION
+# ===========
+#
+# ``get_rama_netcdf.sh`` get RAMA reference files
+#
+# SEE ALSO
+# ========
+#
+# :ref:`guide data RAMA <data_in_rama>`
+#
+# TODO
+# ====
+#
+# trace
+#
+# hard coded directory - usage of ${TROPFLUX_ID}
+#
+# coding rules
+#
+# EVOLUTIONS
+# ==========
+#
+# - fplod 20101213T160928Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * minimal header
+#
+# - jv 2008
+#
+#   * creation
+#
+#-
+
 
 dir=/Users/jv/data/RAMA/data/

trunk/src/get_tao_netcdf.sh

@@ -1 @@
-#!/bin/sh
-
+#! /bin/sh
+#+
+#
+# .. program:: get_tao_netcdf.sh
+#
+# .. _get_tao_netcdf.sh:
+#
+# ============================================
+# get_tao_netcdf.sh -- get TAO reference files
+# ============================================
+#
+#
+# SYNOPSIS
+# ========
+#
+# ::
+#
+#  $ get_tao_netcdf.sh
+#
+# DESCRIPTION
+# ===========
+#
+# ``get_tao_netcdf.sh`` get TAO reference files
+#
+# SEE ALSO
+# ========
+#
+# :ref:`guide data TAO <data_in_tao>`
+#
+# TODO
+# ====
+#
+# trace
+#
+# hard coded directory - usage of ${TROPFLUX_ID}
+#
+# coding rules
+#
+# EVOLUTIONS
+# ==========
+#
+# - fplod 20101213T161152Z aedon.locean-ipsl.upmc.fr (Darwin)
+#
+#   * minimal header
+#
+# - jv 2008
+#
+#   * creation
+#
+#-
 dir=/Users/jv/data/TAO/data/
 
@@ -37 +85 @@
 
 ls -l
-
-#