Changes between Version 12 and Version 13 of doc/app/vapor

Timestamp:

Dec 4, 2012 8:57:11 AM (12 years ago)

Author:

maronga

Comment:

--

doc/app/vapor

@@ -16 +16 @@
 VAPOR has its own mechanism for storing field data and its associated attributes (metadata). The components of a VAPOR Data Collection (VDC) are distributed across different disk files. All metadata for a VDC are stored in a single .vdf file. See [[http://www.vapor.ucar.edu/docs/vapor-data-preparation/vapor-data-preparation|here]] for more information.\\
 \\
-For the conversion of NetCDF data output from PALM to the VAPOR format, the tool nc2vdf has been developed at IMUK. It is available from r1046. In order to use the tool on any remote host, the PALM utility programs must be recompiled ({{{mbuild -u -h ...}}}). nc2vdf collects a list of parameters and uses the command line tools vdfcreate and ncdf2vdf, that come with VAPOR, to create the metadata file and populate the data collection automatically with all variables and time steps chosen by the user.\\
-The tool can be used in two ways, an interactive command line prompt asking for all necessary information and a non interactive mode reading all input parameters from a configuration file. The non interactive mode may be preferred for converting large data sets and can be used as a batch job on the UV systems at HLRN.\\
+For the conversion of NetCDF data output from PALM to the VAPOR format, the tool nc2vdf has been developed at IMUK. It is based on NCL and available from r1046. In order to use the tool on any remote host, the PALM utility programs must be recompiled ({{{mbuild -u -h ...}}}). nc2vdf collects a list of parameters and uses the command line tools vdfcreate and ncdf2vdf, that come with VAPOR, to create the metadata file and populate the data collection automatically with all variables and time steps chosen by the user.\\
+The tool can be used in two ways, an interactive command line prompt asking for all necessary information and a non interactive mode reading all input parameters from a configuration file. The non interactive mode may be preferred for converting large data sets and can be used as a batch job at HLRN (so far only hicegate2 and bicegate2 are allowed). For large batch jobs that would exceed the wallclock time limit of the shell, you might want to submit a batch job (currently only possible on the UV systems).\\
 \\
-The script can be started from the terminal in interactive mode by:\\
-{{{nc2vdf}}} ,\\
-or providing a configuration file via:\\
-{{{nc2vdf ./anypath/nc2vdf.config}}} .
-\\
-An example configuration file can be found in the folder trunk/SCRIPTS. The configuration uses NCL syntax.\\
-\\
-To use nc2vdf on your own workstation with VAPOR installed (Linux or Mac systems) you may edit the appropriate lines in the NCL script nc2vdf.ncl.
+=== Starting the conversion ===
+The conversion can be started interactively, as local batch job at IMUK/HLRN or as batch job at UV. To use nc2vdf on your own workstation with VAPOR installed (Linux or Mac systems) you may edit the appropriate lines in the NCL script nc2vdf.ncl. The following instructions have to been executed in the directory where the data reside.
+
+==== Interactive mode at IMUK/HLRN ====
+Simply type\\\\
+{{{nc2vdf}}}\\\\
+and the script will guide you trough the conversion.
+
+==== Batch mode at IMUK/HLRN ====
+Provide a configuration file (usually {{{nc2vdf.config}}}). An example configuration file can be found in the folder {{{trunk/SCRIPTS/}}}. The configuration uses NCL syntax. Run the script as follows:\\\\
+{{{nc2vdf ./anypath/nc2vdf.config}}}
+
+
+==== Batch mode on UV at HLRN ====
+For submitting a batch job to the UV system, a job script is required. Please find a default job script in {{{trunk/SCRIPTS/batch_nc2vdfcat}}}. The script should be copied to the directory where your data resides. Change into this directory and submit the job as follows:\\
+{{{msub batch_nc2vdfcat}}}
 
 == Starting VAPOR at IMUK ==