Commit 39177a77 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu for distgrid

parent 84ac5b86
......@@ -65,6 +65,8 @@ doc/tex/cdo_ref_over.tex -text
doc/tex/cdoprog.tex -text
doc/tex/cleanup -text
doc/tex/contributors.tex -text
doc/tex/figures/gather.pdf -text
doc/tex/figures/scatter.pdf -text
doc/tex/grid.tex -text
doc/tex/grids/cell.gmt -text
doc/tex/grids/cell.grid -text
......@@ -153,6 +155,7 @@ doc/tex/mod/Filter -text
doc/tex/mod/Fldcor -text
doc/tex/mod/Fldcovar -text
doc/tex/mod/Fldstat -text
doc/tex/mod/Gather -text
doc/tex/mod/Genweights -text
doc/tex/mod/Gradsdes -text
doc/tex/mod/Gridboxstat -text
......@@ -197,6 +200,7 @@ doc/tex/mod/Rhopot -text
doc/tex/mod/Rotuv -text
doc/tex/mod/Runpctl -text
doc/tex/mod/Runstat -text
doc/tex/mod/Scatter -text
doc/tex/mod/Seaspctl -text
doc/tex/mod/Seasstat -text
doc/tex/mod/Selbox -text
......
......@@ -12,6 +12,8 @@ Merge File operations
Split File operations
Splittime File operations
Splitsel File operations
Scatter File operations
Gather File operations
Select Selection
Selvar Selection
Seltime Selection
......
......@@ -27,6 +27,8 @@
\newcommand{\CDO}{{\bfseries\sffamily CDO}}
\newcommand{\cdologo}{\includegraphics{logo/cdo_logo}}
\graphicspath{{figures/}}
% To define headers and footers
\usepackage{fancyhdr}
\pagestyle{fancy}
......
@BeginModule
@NewPage
@Name = Gather
@Title = Gather
@Section = File operations
@Class = File operation
@Arguments = ifiles ofile
@Operators = gather
@EndModule
@BeginOperator_gather
@Title = Gather
@BeginDescription
Merges grid points of all variables from @file{ifile2} to @file{ifile1} and write the result to @file{ofile}.
Only the non missing values of @file{ifile2} will be used. The horizontal grid of @file{ifile2} should
be smaller or equal to the grid of @file{ifile1} and the resolution must be the same.
Only rectilinear grids are supported. Both input files need to have the same variables
and the same number of timesteps.
@IfDoc
@EndifDoc
\includegraphics[width=\textwidth]{gather.pdf}
@EndDescription
@EndOperator
@BeginModule
@NewPage
@Name = Distgrid
@Title = Distribute horizontal grid
@Section = File operations
@Class = File operation
@Arguments = ifile obase
@Operators = distgrid
@EndModule
@BeginOperator_distgrid
@Title = Distribute horizontal grid
@Parameter = nx [ny]
@BeginDescription
This operator distributes a dataset into smaller pieces. Each output file contains a different region of the horizontal
source grid. A target grid region contains a regular longitude/latitude box of the source grid. Only rectilinear source
grids are supported by this operator. The number of different regions can be specified with the parameter @var{nx} and @var{ny}.
The output files will be named <obase><xxx><suffix> where suffix is the filename extension derived from the file format.
xxx will have five digits with the number of the target region.
@EndDescription
@EndOperator
@BeginParameter nx
@Item = nx
INTEGER Number of regions in x direction
@Item = ny
INTEGER Number of regions in y direction [default: 1]
@EndParameter
@BeginNote
This operator needs to open all output files simultaneously.
The maximum number of open files depents on the operating system!
@EndNote
@BeginExample
Distribute a file into 6 smaller files, each output file receives one half of x and a third of y of the source grid:
@BeginVerbatim
cdo distgrid,2,3 ifile.nc obase
@EndVerbatim
@IfDoc
Below is a schematic illustration of the example:
\includegraphics[width=\textwidth]{scatter.pdf}
On the left side is the data of the input file and on the right side are the data of the six output files.
@EndifDoc
@EndExample
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment