[Python-modules-commits] [cf-python] 07/16: Added manpages, extracted from the scripts manually.
Klaus Zimmermann
zklaus-guest at moszumanska.debian.org
Tue Sep 13 06:47:51 UTC 2016
This is an automated email from the git hooks/post-receive script.
zklaus-guest pushed a commit to branch master
in repository cf-python.
commit 8870e586c68e8beb7e49b5bd271f261cb632a3b8
Author: Klaus Zimmermann <klaus_zimmermann at gmx.de>
Date: Fri Sep 9 17:40:56 2016 +0200
Added manpages, extracted from the scripts manually.
Signed-off-by: Klaus Zimmermann <klaus_zimmermann at gmx.de>
---
debian/cfa.1 | 676 ++++++++++++++++++++++++++++++++++++++++++++++
debian/cfdump.1 | 640 +++++++++++++++++++++++++++++++++++++++++++
debian/python-cf.manpages | 4 +-
3 files changed, 1318 insertions(+), 2 deletions(-)
diff --git a/debian/cfa.1 b/debian/cfa.1
new file mode 100644
index 0000000..9837985
--- /dev/null
+++ b/debian/cfa.1
@@ -0,0 +1,676 @@
+.TH "CFA" "1" "1.3.1" "2016-09-09" "cfa"
+.
+.
+.
+.SH NAME
+cfa \- create aggregated CF datasets
+.
+.
+.
+.SH SYNOPSIS
+.
+cfa [\-d dir] [\-f format] [\-h] [\-i] [\-n] [\-o file] [\-u] [\-v] [\-x] [OPTIONS] INPUTS
+.
+.
+.SH DESCRIPTION
+.
+.
+The cfa tool creates and writes to disk the CF fields contained in
+files contained in the
+.ft B
+INPUTS
+.ft P
+(which may include directories if the
+.ft B
+\-\-recursive
+.ft P
+option is set).
+
+Accepts CF\-netCDF and CFA\-netCDF files (or URLs if DAP access is
+enabled), Met Office (UK) PP files and Met Office (UK) fields files as
+input. Multiple input files in a mixture of formats may be given and
+normal UNIX file globbing rules apply.
+
+Output files are in CF\-netCDF or CFA\-netCDF format (see the
+.ft B
+\-f
+.ft P
+option).
+Both output types are available in netCDF3 and netCDF4 formats. Note
+that the netCDF3 formats are generally slower to write than the
+netCDF4 formats, by several orders of magnitude if files with many
+data variables are involved. However, not all software can read
+netCDF4, so it is advisable to check before writing in this format.
+
+By default the contents of each input file is aggregated
+(i.e. combined) into as few multi\-dimensional CF fields as
+possible. Unaggregatable fields in the input files may be omitted from
+the output (see the
+.ft B
+\-x
+.ft P
+option). Information on which fields are unaggregatable, and why, may
+be displayed (see the
+.ft B
+\-\-info
+.ft P
+option). All aggregation may be turned off with the
+.ft B
+\-n
+.ft P
+option, in which case all input fields are output without
+modification.
+
+See the AGGREGATION section for details on the aggregation process and
+unaggregatable fields.
+
+By default one output file is created per input file. In this case
+there is no inter\-file aggregation and the contents of each file is
+aggregated independently of the others. Output file names are created
+by removing the suffix \.pp, \.nc or \.nca, if there is one, from each
+input file name and then adding a new suffix of \.nc or \.nca for
+CF\-netCDF and CFA\-netCDF output formats respectively. If the
+.ft B
+\-d
+.ft P
+option is set then all output files will be written to the specified
+directory, otherwise each output file will be written to the same
+directory as its input file.
+
+Alternatively, all of the input files may be treated collectively as a
+single CF dataset and written to a single output file (see the
+.ft B
+\-o
+.ft P
+option). In this case aggregation is attempted within and between the
+input files.
+
+An error occurs if an output file has the same full name as any of the
+input files or any other output file.
+.
+.
+.
+.
+.SH AGGREGATION
+.
+.
+.
+Aggregation of input fields into as few multi\-dimensional CF fields
+as possible is carried out according to the aggregation rules
+documented in CF ticket #78 (http://kitt.llnl.gov/trac/ticket/78). For
+each input field, the aggregation process creates a
+.ft I
+structural signature
+.ft P
+which is essentially a subset of the metadata of the field, including
+coordinate metadata and other domain information, but which contains
+no data values. The structural signature accounts for the following
+standard CF properties:
+
+.RS
+add_offset, calendar, cell_methods, _FillValue, flag_masks,
+flag_meanings, flag_values, missing_value, scale_factor,
+standard_error_multiplier, standard_name, units, valid_max, valid_min,
+valid_range
+.RE
+
+Aggregation is then attempted on each group of fields with the same,
+well defined structural signature, and will succeed where the
+coordinate data values imply a safe combination into a single dataset.
+
+Not all fields are aggregatable. Unaggregatable fields are those
+without a well defined structural signature; or those with the same
+structural signature when at least two of them 1) can't be
+unambiguously distinguished by coordinates or other domain information
+or 2) contain coordinate reference fields or ancillary variable fields
+which themselves can't be unambiguously aggregated.
+.
+.
+.
+.SH EXAMPLES
+.
+.
+Create a new netCDF3 classic file containing the aggregatable fields
+in all of the input files:
+
+.RS
+cfa \-o newfile.nc *.nc
+.RE
+
+Create, in an existing directory and overwriting any exisiting files,
+new netCDF3 classic files containing the aggregatable fields in each
+input file:
+
+.RS
+cfa \-d directory \-\-overwrite *.pp
+.RE
+
+Create a new netCDF4 file containing all fields in all of the input
+files:
+
+.RS
+cfa \-f NETCDF4 \-o newfile.nc *.nc
+.RE
+
+Create a new CFA-netCDF4 file containing all fields in all of the
+input files and allow long names or netCDF variable names to identify
+fields and their components:
+
+.RS
+cfa \-i \-f CFA4 \-o newfile.nc *.nc
+.RE
+.
+.
+.
+.SH OPTIONS
+.
+.
+.
+.TP
+.B \-\-axis=property
+Aggregation configuration: Create a new axis for each input field
+which has given property. If an input field has the property then,
+prior to aggregation, a new axis is created with an auxiliary
+coordinate whose data array is the property's value. This allows for
+the possibility of aggregation along the new axis. The property itself
+is deleted from that field. No axis is created for input fields which
+do not have the specified property.
+
+Multiple axes may be created by specifying more than one
+.ft B
+\-\-axis
+.ft P
+option.
+
+For example, if you wish to aggregate an ensemble of model
+experiments that are distinguished by the source property, you can use
+.ft B
+\-\-axis=source
+.ft P
+to create an ensemble axis which has an auxiliary coordinate variable
+containing the source property values.
+.
+.
+.TP
+.B \-\-cfa_base=[value]
+For output CFA\-netCDF files only. File names referenced by an output
+CFA\-netCDF file have relative, as opposed to absolute, paths or URL
+bases. This may be useful when relocating a CFA\-netCDF file together
+with the datasets referenced by it.
+.PP
+.RS
+If set with no value (\-\-cfa_base=) or the value is empty then file
+names are given relative to the directory or URL base containing the
+output CFA\-netCDF file. If set with a non\-empty value then file
+names are given relative to the directory or URL base described by the
+value.
+.PP
+By default, file names within CFA\-netCDF files are stored with
+absolute paths. Ignored for output files of any other format.
+.RE
+.RE
+.
+.
+.TP
+.B \-\-compress=N
+
+Regulate the speed and efficiency of compression. Must be an integer
+between 0 and 9. By default N is 0, meaning no compression; 1 is the
+fastest, but has the lowest compression ratio; 9 is the slowest but
+best compression ratio.
+
+.
+.
+.TP
+.B \-\-contiguous
+Aggregation configuration: Requires that aggregated fields have
+adjacent dimension coordinate cells which partially overlap or share
+common boundary values. Ignored if the dimension coordinates do not
+have bounds.
+.
+.
+.TP
+.B \-d dir, \-\-directory=dir
+Specify the output directory for all output files.
+.
+.
+.TP
+.B \-\-double
+Write 32-bit floats as 64-bit floats and 32-bit integers as 64-bit
+integers. By default, input data types are preserved.
+.
+.
+.TP
+.B \-\-equal=property
+Aggregation configuration: Require that an input field may only be
+aggregated with other fields if they all have the given CF property
+(standard or non-standard) with equal values. Ignored for any input
+field which does not have this property, or if the property is already
+accounted for in the structural signature.
+
+Supersedes the behaviour for the given property that may be implied by
+the
+.ft B
+\-\-exist_all
+.ft P
+option.
+
+Multiple properties may be set by specifying more than one
+.ft B
+\-\-equal
+.ft P
+option.
+.
+.
+.TP
+.B \-\-equal_all
+Aggregation configuration: Require that an input field may only be
+aggregated with other fields that have the same set of CF properties
+(excluding those already accounted for in the structural signature)
+with equal sets of values.
+
+The behaviour for individual properties may be overridden by the
+.ft B
+\-\-exist \-\-ignore
+.ft P
+options.
+
+For example, to insist that a group of aggregated input fields must
+all have the same CF properties (other than those accounted for in the
+structural signature) with matching values, but allowing the long_name
+properties have unequal values, you can use
+.ft B
+\-\-equal_all \-\-exist=long_name
+.ft P
+.
+.
+.TP
+.B \-\-exist=property
+Aggregation configuration: Require that an input field may only be
+aggregated with other fields if they all have the given CF property
+(standard or non-standard), but not requiring the values to be the
+same. Ignored for any input field which does not have this property,
+or if the property is already accounted for in the structural
+signature.
+
+Supersedes the behaviour for the given property that may be implied by
+the
+.ft B
+\-\-equal_all
+.ft P
+option.
+
+Multiple properties may be set by specifying more than one
+.ft B
+\-\-exist
+.ft P
+option.
+.
+.
+.TP
+.B \-\-exist_all
+Aggregation configuration: Require that an input field may only be
+aggregated with other fields that have the same set of CF properties
+(excluding those already accounted for in the structural signature),
+but not requiring the values to be the same.
+
+The behaviour for individual properties may be overridden by the
+.ft B
+\-\-equal \-\-ignore
+.ft P
+options.
+
+For example, to insist that a group of aggregated input fields must
+all have the same CF properties (other than those accounted for in the
+structural signature), regardless of their values, but also insisting
+that the long_name properties have equal values, you can use
+.ft B
+\-\-exist_all \-\-equal=long_name
+.ft P
+.
+.
+.TP
+.B \-f format, \-\-format=format
+Set the format of the output file(s). Valid choices are
+NETCDF3_CLASSIC, NETCDF3_64BIT, NETCDF4, NETCDF4_CLASSIC and
+NETCDF3_64BIT for outputting CF\-netCDF files in those netCDF formats
+and CFA3 or CFA4 for outputting CFA\-netCDF files in NETCDF3_CLASSIC
+or NETCDF4 formats respectively. By default, NETCDF3_CLASSIC is
+assumed.
+.PP
+.RS
+Note that the netCDF3 formats are generally slower to write than the
+netCDF4 formats, by several orders of magnitude if files with many
+data variables are involved. However, not all software can read
+netCDF4, so it is advisable to check before writing in this format.
+.RE
+.
+.
+.TP
+.B \-h, \-\-help
+Display this man page.
+.
+.
+.TP
+.B \-i, \-\-relaxed_identities
+Aggregation configuration: In the absence of standard names, allow
+fields and their components (such as coordinates) to be identified by
+their long_name CF properties or else their netCDF file variable
+names.
+.
+.
+.TP
+.B \-\-ignore=property
+Aggregation configuration: An input field may be aggregated with other
+fields regardless of whether or not they have the given CF property
+(standard or non-standard) and regardless of its values. Ignored for
+any input field which does not have this property, or if the property
+is already accounted for in the structural signature.
+
+This is the default behaviour in the absence of all the
+.ft B
+\-\-exist \-\-equal \-\-exist_all \-\-equal_all
+.ft P
+options and supersedes the behaviour for the given property that may
+be implied if any of these options are set.
+
+Multiple properties may be set by specifying more than one
+.ft B
+\-\-ignore
+.ft P
+option.
+
+For example, to insist that a group of aggregated input fields must
+all have the same CF properties (other than those accounted for in the
+structural signature) with the same values, but with no restrictions
+on the existence or values of the long_name property you can use
+.ft B
+\-\-equal_all \-\-ignore=long_name
+.ft P
+.
+.
+.TP
+.B \-\-fletcher32
+Activate the Fletcher-32 HDF5 checksum algorithm to detect compression
+errors. Ignored if there is no compression (see the
+.ft B
+\-\-compress
+.ft P
+option).
+.
+.
+.TP
+.B \-\-follow_symlinks
+In combination with
+.ft B
+\-\-recursive
+.ft P
+also search for files in directories which resolve to symbolic
+links. Files specified by the
+.ft B
+INPUTS
+.ft P
+which are symbolic links are always followed. Note that setting
+.ft B
+\-\-recursive --follow_symlinks
+.ft P
+can lead to infinite recursion if a directory which resolves to a
+symbolic link points to a parent directory of itself.
+.
+.
+.TP
+.B \-\-ignore_read_error
+Ignore, without failing, any input file which causes an error whilst
+being read, as would be the case for an empty file, unknown file
+format, etc. By default an error occurs in this case.
+.
+.
+.TP
+.B \-\-info=N
+Aggregation configuration: Print information about the aggregation
+process. If N is 0 then no information is displayed. If N is 1 or more
+then display information on which fields are unaggregatable, and
+why. If N is 2 or more then display the field structural signatures
+and, when there is more than one field with the same structural
+signature, their canonical first and last coordinate values. If N is 3
+or more then display the field complete aggregation metadata.
+
+By default N is 0.
+.
+.
+.TP
+.B \-\-least_sig_digit=N
+Truncate the input field data arrays. For a positive integer N the
+precision that is retained in the compressed data is '10 to the power
+-N'. For example, if N is 2 then a precision of 0.01 is retained. In
+conjunction with compression this produces 'lossy', but significantly
+more efficient compression (see the
+.ft B
+\-\-compress
+.ft P
+option).
+.
+.
+.TP
+.B \-\-ncvar_identities
+Aggregation configuration: Force fields and their components (such as
+coordinates) to be identified by their netCDF file variable names.
+.
+.
+.TP
+.B \-n, \-\-no_aggregation
+Aggregation configuration: Do not aggregate fields. Writes the input
+fields as they exist in the input files.
+.
+.
+.TP
+.B \-\-no_overlap
+Aggregation configuration: Requires that aggregated fields have
+adjacent dimension coordinate cells which do not overlap (but they may
+share common boundary values). Ignored if the dimension coordinates do
+not have bounds.
+.
+.
+.TP
+.B \-\-no_shuffle
+Turn off the HDF5 shuffle filter, which de-interlaces a block of data
+before compression by reordering the bytes by storing the first byte
+of all of a variable's values in the chunk contiguously, followed by
+all the second bytes, and so on. By default the filter is applied
+because if the data array values are not all wildly different, using
+the filter can make the data more easily compressible. Ignored if
+there is no compression (see the
+.ft B
+\-\-compress
+.ft P
+option).
+.
+.
+.TP
+.B \-o file, \-\-outfile=file
+Treat all input files collectively as a single CF dataset. In this
+case aggregation is attempted within and between the input files and
+all outputs are written to the specified file.
+.
+.
+.TP
+.B \-\-overwrite
+Allow pre\-existing output files to be overwritten.
+.
+.
+.TP
+.B \-\-promote=component
+Promote field components to independent top-level fields. If component
+is ancillary then ancillary data fields are promoted. If component is
+auxiliary then auxiliary coordinate variables are promoted. If
+component is measure then cell meausure variables are promoted. If
+component is reference then fields pointed to from formula_terms
+attributes are promoted. If component is field then all component
+fields are promoted.
+
+Multiple conponent types may be promoted by specifying more than one
+.ft B
+\-\-promote
+.ft P
+option.
+
+For example, promote to ancillary data field and cell measure
+variables to independent, top-level fields you can use
+.ft B
+\-\-promote=ancillary --promote=measure
+.ft P
+.
+.
+.TP
+.B \-\-recursive
+Allow directories to be specified by the
+.ft B
+INPUTS
+.ft P
+and recursively search the directories for actual files to read. Set
+the
+.ft B
+\-\-ignore_read_error
+.ft P
+option to bypass any unreadable files and the
+.ft B
+\-\-follow_symlinks
+.ft P
+option to allow directories to be symbolic links.
+.
+.
+.TP
+.B \-\-reference_datetime=datetime
+Set the reference date-time of time coordinate units to an ISO
+8601-like date-time. Changing the reference date-time does not change
+the absolute date-times of the coordinates. Ignored for non-reference
+date-time coordinates. Some examples of valid date-times: 1830-12-1,
+"1830-12-09 2:34:45Z".
+.
+.
+.TP
+.B \-\-respect_valid
+Aggregation configuration: Take into account the CF properties
+valid_max, valid_min and valid_range during aggregation. By default
+they are ignored for the purposes of aggregation and deleted from any
+aggregated output CF fields.
+.
+.
+.TP
+.B \-\-shared_nc_domain
+Aggregation configuration: Match axes between a field and its
+contained ancillary variable and coordinate reference fields via their
+netCDF dimension names and not via their domains.
+.
+.
+.TP
+.B \-\-single
+Write 64-bit floats as 32-bit floats and 64-bit integers as 32-bit
+integers. By default, input data types are preserved.
+.
+.
+.TP
+.B \-\-squeeze
+Remove size 1 axes from the output field data arrays. If a size one
+axis has any one dimensional coordinates then these are converted to
+CF scalar coordinates.
+.
+.
+.TP
+.B \-u, \-\-relaxed_units
+Aggregation configuration: Assume that fields or their components
+(such as coordinates) with the same standard name (or other
+identifiers, see the
+.ft B
+\-i
+.ft P
+option) but missing units all have equivalent (but unspecified) units,
+so that aggregation may occur. This is the default for Met Office (UK)
+PP files and Met Office (UK) fields files, but not for other formats.
+.
+.
+.TP
+.B \-\-unsqueeze
+Include size 1 axes in the output field data arrays. If a size one
+axis has any CF scalar coordinates then these are converted to one
+dimensional coordinates.
+.
+.
+.TP
+.B \-\-um_version=version
+For Met Office (UK) PP files and Met Office (UK) fields files only,
+the Unified Model (UM) version to be used when decoding the
+header. Valid versions are, for example, 4.2, 6.6.3 and 8.2. The
+default version is 4.5. In general, the given version is ignored if it
+can be inferred from the header (which is usually the case for files
+created by the UM at versions 5.3 and later). The exception to this is
+when the given version has a third element (such as the 3 in 6.6.3),
+in which case any version in the header is ignored. This option is
+ignored for input files which are not Met Office (UK) PP files or Met
+Office (UK) fields files.
+.
+.
+.TP
+.B \-\-unlimited=axis
+Create an unlimited dimension (a dimension that can be appended to). A
+dimension is identified by either a standard name; one of T, Z, Y, X
+denoting time, height or horixontal axes (as defined by the CF
+conventions); or the value of an arbitrary CF property preceeded by
+the property name and a colon. For example:
+
+Multiple unlimited axes may be defined by specifying more than one
+.ft B
+\-\-unlimited
+.ft P
+option. Note, however, that only netCDF4 formats support multiple
+unlimited dimensions. For example, to set the time and Z dimensions to
+be unlimited you could use
+.ft B
+\-\-unlimited=time \-\-unlimited=Z
+.ft P
+
+An example of defining an axis by an arbitrary CF property could be
+.ft B
+\-\-unlimited=long_name:pseudo_level
+.ft P
+.
+.
+.TP
+.B \-v, \-\-verbose
+Display a one\-line summary of each output CF field.
+.
+.
+.TP
+.B \-x, \-\-exclude
+Aggregation configuration: Omit unaggregatable fields from the
+output. Ignored if the
+.ft B
+\-n
+.ft P
+option is set. See the AGGREGATION section for the definition of an
+unaggregatable field.
+.
+.
+.
+.SH SEE ALSO
+cfdump(1)
+.
+.
+.
+.SH LIBRARY
+cf\-python library version 1.3.1
+.
+.
+.
+.SH BUGS
+Reports of bugs are welcome at http://cfpython.bitbucket.org/
+.
+.
+.
+.SH LICENSE
+Open Source Initiative MIT License
+.
+.
+.
+.SH AUTHOR
+David Hassell
diff --git a/debian/cfdump.1 b/debian/cfdump.1
new file mode 100644
index 0000000..3bf2229
--- /dev/null
+++ b/debian/cfdump.1
@@ -0,0 +1,640 @@
+.TH "CFDUMP" "1" "1.3.1" "2016-09-09" "cfdump"
+.
+.
+.
+.SH NAME
+cfdump \- view CF fields
+.
+.
+.
+.SH SYNOPSIS
+.
+cfdump [\-1] [\-c] [\-h] [\-i] [\-l] [\-n] [\-s] [\-u] [\-x] [OPTIONS] INPUTS
+.
+.
+.
+.SH DESCRIPTION
+.
+.
+.
+The cfdump tool generates text representations on standard output of
+the CF fields contained in the
+.ft B
+INPUTS
+.ft P
+(which may include directories if the
+.ft B
+\-\-recursive
+.ft P
+option is set).
+
+Accepts CF\-netCDF and CFA\-netCDF files (or URLs if DAP access is
+enabled), Met Office (UK) PP files and Met Office (UK) fields files as
+input. Multiple input files in a mixture of formats may be given and
+normal UNIX file globbing rules apply.
+
+By default the contents of each input file is aggregated
+(i.e. combined) into as few multi\-dimensional CF fields as
+possible. Unaggregatable fields in the input files may be omitted from
+the output (see the
+.ft B
+\-x
+.ft P
+option). Information on which fields are unaggregatable, and why, may
+be displayed (see the
+.ft B
+\-\-info
+.ft P
+option). All aggregation may be turned off with the
+.ft B
+\-n
+.ft P
+option, in which case all input fields are output without
+modification.
+
+See the AGGREGATION section for details on the aggregation process and
+unaggregatable fields.
+
+By default each input file is treated separately. In this case there
+is no inter\-file aggregation, but the contents of each file is
+aggregated independently of the others.
+
+Alternatively, all of the input files may be treated collectively as a
+single CF dataset (see the
+.ft B
+\-1
+.ft P
+option). In this case aggregation is attempted within and between the
+input files.
+
+In the displayed output, each component of a field is assigned one of
+the following roles as defined by the CF data model:
+.PP
+.RS
+.nf
+Field
+Axis
+Cell method
+Dimension coordinate
+Auxiliary coordinate
+Cell measure
+Coordinate reference
+.fi
+.RE
+.PP
+A field and its components are identified, where appropriate, by their
+standard names if available, or their long names. If neither is
+present then a netCDF variable name is used. Long names and netCDF
+variable names are preceded by long_name: and ncvar:
+respectively. Axis identities are inferred from the coordinates which
+span them.
+.PP
+Each data array of a field and its components is described by its
+dimensionality, units and (depending on the extent of the output
+requested) its first and last values. For longer and complete outputs,
+arrays containing coordinate bounds are given in the same way and
+included as part of their coordinates' descriptions.
+.
+.
+.
+.SH AGGREGATION
+.
+.
+.
+Aggregation of input fields into as few multi\-dimensional CF fields
+as possible is carried out according to the aggregation rules
+documented in CF ticket #78 (http://kitt.llnl.gov/trac/ticket/78). For
+each input field, the aggregation process creates a
+.ft I
+structural signature
+.ft P
+which is essentially a subset of the metadata of the field, including
+coordinate metadata and other domain information, but which contains
+no data values. The structural signature accounts for the following
+standard CF properties:
+
+.RS
+add_offset, calendar, cell_methods, _FillValue, flag_masks,
+flag_meanings, flag_values, missing_value, scale_factor,
+standard_error_multiplier, standard_name, units, valid_max, valid_min,
+valid_range
+.RE
+
+Aggregation is then attempted on each group of fields with the same,
+well defined structural signature, and will succeed where the
+coordinate data values imply a safe combination into a single dataset.
+
+Not all fields are aggregatable. Unaggregatable fields are those
+without a well defined structural signature; or those with the same
+structural signature when at least two of them 1) can't be
+unambiguously distinguished by coordinates or other domain information
+or 2) contain coordinate reference fields or ancillary variable fields
+which themselves can't be unambiguously aggregated.
+.
+.
+.
+.SH EXAMPLES
+.
+.
+.
+In these examples, a complete dataset has been split across two files
+(file1.nc and file2.nc). These may be passed to cfdump which can
+return a description of the recombined, aggregated field. The
+.ft B
+\-1
+.ft P
+option is necessary here so that the two input files are treated as
+parts of the same dataset.
+
+The
+.ft B
+\-s
+.ft P
+option displays the short, one\-line output, which gives the identity
+of the field (air_temperature), the identities and sizes of its data
+array dimensions (time, latitude and longitude with sizes 1200, 64 and
+128 respectively) and the units of the field's data array (K):
+
+.nf
+ $ cfdump \-1s file1.nc file2.nc
+ <CF Field: air_temperature(time(1200), latitude(64), longitude(128)) K>
+.fi
+.PP
+The default summary gives the same information as the the one\-line
+output, along with short descriptions of the field's other components:
+.PP
+.nf
+ $ cfdump \-1 file[12].nc
+ air_temperature field summary
+ -----------------------------
+ Data : air_temperature(time(1200), latitude(64), longitude(128)) K
+ Cell methods : time: mean (interval: 1.0 month)
+ Axes : time(12) = [ 450\-11\-16 00:00:00, ..., 550\-10\-16 12:00:00] noleap calendar
+ : latitude(64) = [\-87.8638000488, ..., 87.8638000488] degrees_north
+ : longitude(128) = [0.0, ..., 357.1875] degrees_east
+ : height(1) = [2.0] m
+.fi
+
+This shows that the aggregated field has a cell method and four
+dimension coordinates, one of which (height) is a coordinate for a
+size 1 dimension that is not a dimension of the field's data
+array. The units and first and last values of the coordinates' data
+arrays are given and relative time values are translated into strings.
+
+The
+.ft B
+\-l
+.ft P
+option displays the long output, which includes each component's
+properties, as well as the first and last values of the field's data
+array:
+
+.nf
+ $ cfdump \-1l file[1\-2].nc
+ ======================
+ Field: air_temperature
+ ======================
+ Axes
+ height(1)
+ latitude(64)
+ longitude(128)
+ time(12)
+
+ Data(time(12), latitude(64), longitude(128)) = [[[236.512756348, ..., 256.93371582]]] K
+ cell_methods = time: mean (interval: 1.0 month)
+
+ experiment_id = 'pre\-industrial control experiment'
+ long_name = 'air_temperature'
+ missing_value = 1e+20
+ standard_name = 'air_temperature'
+
+ Dimension coordinate: time
+ Data(time(12)) = [ 450\-11\-16 00:00:00, ..., 550\-10\-16 12:00:00] noleap calendar
+ Bounds(time(12), 2) = [[ 450\-11\-01 00:00:00, ..., 550\-11\-01 00:00:00]] noleap calendar
+ axis = 'T'
+ standard_name = 'time'
+
+ Dimension coordinate: latitude
+ Data(latitude(64)) = [\-87.8638000488, ..., 87.8638000488] degrees_north
+ Bounds(latitude(64), 2) = [[\-90.0, ..., 90.0]] degrees_north
+ axis = 'Y'
+ standard_name = 'latitude'
+
+ Dimension coordinate: longitude
+ Data(longitude(128)) = [0.0, ..., 357.1875] degrees_east
+ Bounds(longitude(128), 2) = [[\-1.40625, ..., 358.59375]] degrees_east
+ axis = 'X'
+ standard_name = 'longitude'
+
+ Dimension coordinate: height
+ Data(height(1)) = [2.0] m
+ axis = 'Z'
+ positive = 'up'
+ standard_name = 'height'
+.fi
+.PP
+In this case, the complete output using the
+.ft B
+\-c
+.ft P
+option would be the same as the long output, since there are no fields
+contained in coordinate references nor ancillary variables.
+.
+.
+.
+.SH OPTIONS
+.
+.
+.
+.TP
+.B \-1, \-\-one
+Treat all input files collectively as a single CF dataset. In this
+case aggregation is attempted within and between the input files.
+.
+.
+.TP
+.B \-\-axis=property
+Aggregation configuration: Create a new axis for each input field
+which has given property. If an input field has the property then,
+prior to aggregation, a new axis is created with an auxiliary
+coordinate whose data array is the property's value. This allows for
+the possibility of aggregation along the new axis. The property itself
+is deleted from that field. No axis is created for input fields which
+do not have the specified property.
+
+Multiple axes may be created by specifying more than one
+.ft B
+\-\-axis
+.ft P
+option.
+
+For example, if you wish to aggregate an ensemble of model
+experiments that are distinguished by the source property, you can use
+.ft B
+\-\-axis=source
+.ft P
+to create an ensemble axis which has an auxiliary coordinate variable
+containing the source property values.
+.
+.
+.TP
+.B \-c, \-\-complete
+Display complete outputs. Fields are described without abbreviation
+with the exception of data arrays, which are abbreviated to their
+first and last values. Fields contained in transforms and ancillary
+variables are given as long outputs (see the
+.ft B
+\-l
+.ft P
+option).
+.
+.
+.TP
+.B \-\-contiguous
+Aggregation configuration: Requires that aggregated fields have
+adjacent dimension coordinate cells which partially overlap or share
+common boundary values. Ignored if the dimension coordinates do not
+have bounds.
+.
+.
... 350 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/cf-python.git
More information about the Python-modules-commits
mailing list