Skip to content

Commit 9a63831

Browse files
underwoounderwoo
committed
Added more man pages for moved programs now in src
1 parent 340fe06 commit 9a63831

File tree

9 files changed

+1813
-1185
lines changed

9 files changed

+1813
-1185
lines changed

‎.vscode/settings.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
{
22
"cSpell.words": [
3-
"mppnccombine"
3+
"Balaji",
4+
"Forrestal",
5+
"Malyshev",
6+
"Mohan",
7+
"mppnccombine",
8+
"Sergey",
9+
"Tauber",
10+
"Tushar",
11+
"Vahlenkamp"
412
],
513
"cSpell.languageSettings": [
614
{

‎man/Makefile.am‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,13 @@
1818
# <http://www.gnu.org/licenses/>.
1919
#***********************************************************************
2020
EXTRA_DIST = \
21+
combine-ncc.txt \
2122
combine_restarts.txt \
23+
decompress-ncc.txt \
2224
iceberg_comb.sh.txt \
25+
is-compressed.txt \
26+
mppnccombine.txt \
27+
scatter-ncc.txt \
2328
asciidoc.conf
2429

2530
# Documentation settings
@@ -30,8 +35,13 @@ man_MANS =
3035

3136
if WITH_ASCIIDOC
3237
man_MANS += \
38+
combine-ncc.1 \
3339
combine_restarts.1 \
34-
iceberg_comb.sh.1
40+
decompress-ncc.1 \
41+
iceberg_comb.sh.1 \
42+
is-compressed.1 \
43+
mppnccombine.1 \
44+
scatter-ncc.1
3545
endif
3646

3747
.txt.1:

‎man/combine-ncc.txt‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
combine-ncc(1)
2+
==============
3+
4+
NAME
5+
----
6+
combine-ncc - combine compressed-by-gathering netCDF files
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
combine-ncc [options] in.nc [...] out.nc
12+
13+
DESCRIPTION
14+
-----------
15+
16+
Combines several compressed-by-gathering netcdf files into one.
17+
Normally used to combine lm3 restarts generated by each processor.
18+
19+
Warning: the output file, if it exists, is overwritten.
20+
21+
OPTIONS
22+
-------
23+
24+
*-v verbosity-level*::
25+
Specifies level of verbosity output verbosity
26+
27+
*-h*, *--help*::
28+
display this help and exit
29+
30+
*-V*, *--version*::
31+
output version information and exit
32+
33+
_in.nc_::
34+
Input file name(s)
35+
36+
_out.nc_::
37+
Output file name
38+
39+
BUGS
40+
----
41+
Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
42+
43+
AUTHORS
44+
-------
45+
Sergey Malyshev
46+
47+
COPYRIGHT AND LICENSE
48+
---------------------
49+
Copyright 2009-2024 Geophysical Fluid Dynamics Laboratory
50+
51+
The Flexible Modeling System (FMS) is free software; you can
52+
redistribute it and/or modify it and are expected to follow the terms
53+
of the GNU General Public License as published by the Free Software
54+
Foundation; either version 2 of the License, or (at your option) any
55+
later version.
56+
57+
FMS is distributed in the hope that it will be useful, but WITHOUT ANY
58+
WARRANTY; without even the implied warranty of MERCHANTABILITY or
59+
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
60+
for more details.

‎man/decompress-ncc.txt‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
decompress-ncc(1)
2+
=================
3+
4+
NAME
5+
----
6+
decompress-ncc - converts a compressed-by-gathering netCDF file to a regular netCDF file
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
decompress-ncc [-v verbosity-level] [-m] in.nc [...] out.nc
12+
13+
DESCRIPTION
14+
-----------
15+
16+
Converts one or several compressed-by-gathering netcdf file into
17+
one regular netcdf. Normally used to convert lm3 restarts into a
18+
form suitable for visualization applications.
19+
20+
OPTIONS
21+
-------
22+
23+
*-v verbosity-level*::
24+
Specifies level of debug output verbosity
25+
26+
*-m*::
27+
Forces adding a missing_value attribute to the variables
28+
that do not have it
29+
30+
*-h*, *--help*::
31+
display this help and exit
32+
33+
*-V*, *--version*::
34+
output version information and exit
35+
36+
_in.nc_::
37+
Input file name(s)
38+
39+
_out.nc_::
40+
Output file name
41+
42+
BUGS
43+
----
44+
Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
45+
46+
AUTHORS
47+
-------
48+
Sergey Malyshev
49+
50+
COPYRIGHT AND LICENSE
51+
---------------------
52+
Copyright 2009-2024 Geophysical Fluid Dynamics Laboratory
53+
54+
The Flexible Modeling System (FMS) is free software; you can
55+
redistribute it and/or modify it and are expected to follow the terms
56+
of the GNU General Public License as published by the Free Software
57+
Foundation; either version 2 of the License, or (at your option) any
58+
later version.
59+
60+
FMS is distributed in the hope that it will be useful, but WITHOUT ANY
61+
WARRANTY; without even the implied warranty of MERCHANTABILITY or
62+
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
63+
for more details.

‎man/is-compressed.txt‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
is-compressed(1)
2+
================
3+
4+
NAME
5+
----
6+
is-compressed - checks if any variable in a netCDF file is compressed-by-gathering
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
is-compressed [options] FILE
12+
13+
DESCRIPTION
14+
-----------
15+
16+
Test if any variable in FILE is compressed-by-gathering.
17+
Exit status is 0 if compressed, 255 if not compressed.
18+
19+
OPTIONS
20+
-------
21+
22+
*-d*, *--debug*::
23+
add verbosity to the output
24+
25+
*-h*, *--help*::
26+
display this help and exit
27+
28+
*-V*, *--version*::
29+
output version information and exit
30+
31+
BUGS
32+
----
33+
Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
34+
35+
AUTHORS
36+
-------
37+
Sergey Malyshev
38+
39+
COPYRIGHT AND LICENSE
40+
---------------------
41+
Copyright 2009-2024 Geophysical Fluid Dynamics Laboratory
42+
43+
The Flexible Modeling System (FMS) is free software; you can
44+
redistribute it and/or modify it and are expected to follow the terms
45+
of the GNU General Public License as published by the Free Software
46+
Foundation; either version 2 of the License, or (at your option) any
47+
later version.
48+
49+
FMS is distributed in the hope that it will be useful, but WITHOUT ANY
50+
WARRANTY; without even the implied warranty of MERCHANTABILITY or
51+
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
52+
for more details.

‎man/mppnccombine.txt‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
mppnccombine(1)
2+
===============
3+
4+
NAME
5+
----
6+
mppnccombine - combine FMS distributed files
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
mppnccombine [options] output.nc [input ...]
12+
13+
DESCRIPTION
14+
-----------
15+
mppnccombine joins together an arbitrary number of netCDF input files, each
16+
containing parts of a decomposed domain, into a unified netCDF output file.
17+
An output file must be specified and it is assumed to be the first filename
18+
argument. If the output file already exists, then it will not be modified
19+
unless the option is chosen to append to it. If no input files are specified
20+
then their names will be based on the name of the output file plus the default
21+
numeric extension ".0000", which will increment by 1. There is an option for
22+
starting the filename extensions with an arbitrary number instead of 0. There
23+
is an option for specifying an end to the range of filename extension numbers;
24+
files within the range do not have to be consecutively numbered. If input
25+
files are specified then names will be used verbatim.
26+
27+
A value of 0 is returned if execution completed successfully; a value of 1
28+
otherwise.
29+
30+
OPTIONS
31+
-------
32+
*-v*::
33+
Print some progress information.
34+
35+
*-V*::
36+
Print version information.
37+
38+
*-M*::
39+
Print memory usage statistics.
40+
41+
*-f*::
42+
Force combine to happen even if input files are missing.
43+
44+
*-a*::
45+
Append to an existing netCDF file (not heavily tested...).
46+
47+
*-r*::
48+
Remove the ".####" decomposed files after a successful run.
49+
50+
*-n #*::
51+
Input filename extensions start with number #### instead of 0000.
52+
53+
*-k #*::
54+
Blocking factor. k records are read from an input file at a time.
55+
Valid values are between 0 and 100. For a given input, the maximum
56+
permissible value for k is min(total number of records, 100).
57+
Setting k to zero will set the blocking factor to this maximum
58+
permissible value. Setting k to a value higher than this value,
59+
will make the system implicitly set k to the highest permissible value.
60+
A value of 1 for k disables blocking. This is the default behavior.
61+
Blocking often improves performance, but increases the peak memory
62+
footprint (by the blocking factor). Beware of running out of
63+
available physical memory and causing swapping to disk due to
64+
large blocking factors and/or large input datasets.
65+
A value of 10 for k has worked well on many input datasets.
66+
See -x for estimating memory usage for a given input set.
67+
68+
*-e #*::
69+
Ending number #### of a specified range of input filename extensions.
70+
Files within the range do not have to be consecutively numbered.
71+
72+
*-h #*::
73+
Add a specified number of bytes of padding at the end of the header.
74+
75+
*-64*::
76+
Create netCDF output files with the 64-bit offset format.
77+
78+
*-n4*::
79+
Create netCDF output files in NETCDF4_CLASSIC mode (no v4 enhanced features).
80+
81+
*-d #*::
82+
When in NETCDF4 mode, use deflation of level #.
83+
84+
*-s*::
85+
When in NETCDF4 mode, use shuffle.
86+
87+
*-m*::
88+
Initialize output variables with a "missing_value" from the variables
89+
of the first input file instead of the default 0 value.
90+
91+
*-x*::
92+
Print an estimate for peak memory resident size in (MB) and exit.
93+
No output file will be created. Setting -x automatically sets
94+
the blocking factor (-k) to 1. Any value set for -k on the
95+
command-line will be ignored. To estimate memory usage for a
96+
a different blocking factor, simply multiply the estimate by k.
97+
98+
BUGS
99+
----
100+
Send bug reports to GFDL's help desk <oar.gfdl.help@noaa.gov>
101+
102+
AUTHORS
103+
-------
104+
Hans Vahlenkamp
105+
106+
COPYRIGHT AND LICENSE
107+
---------------------
108+
Copyright 2008-2024 Geophysical Fluid Dynamics Laboratory
109+
110+
The Flexible Modeling System (FMS) is free software; you can
111+
redistribute it and/or modify it and are expected to follow the terms
112+
of the GNU General Public License as published by the Free Software
113+
Foundation; either version 2 of the License, or (at your option) any
114+
later version.
115+
116+
FMS is distributed in the hope that it will be useful, but WITHOUT ANY
117+
WARRANTY; without even the implied warranty of MERCHANTABILITY or
118+
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
119+
for more details.

0 commit comments

Comments
 (0)