[cdftools] 220/228: Add (incomplete) bash and manpages
Alastair McKinstry
mckinstry at moszumanska.debian.org
Fri Jun 12 08:21:52 UTC 2015
This is an automated email from the git hooks/post-receive script.
mckinstry pushed a commit to branch master
in repository cdftools.
commit cc1ffd2faae35ec5db6e54d8f625a1a77e241e03
Author: Alastair McKinstry <mckinstry at debian.org>
Date: Fri Jun 21 18:14:15 2013 +0100
Add (incomplete) bash and manpages
---
debian/bash.completion | 56 +++++++++++++++++++++++++++++++++++++
debian/cdftools.manpages | 1 +
debian/manpages/cdf16bit.1 | 53 +++++++++++++++++++++++++++++++++++
debian/manpages/cdf2levitusgrid2d.1 | 40 ++++++++++++++++++++++++++
debian/manpages/cdf2matlab.1 | 32 +++++++++++++++++++++
debian/manpages/cdfbathy.1 | 49 ++++++++++++++++++++++++++++++++
debian/manpages/cdfbci.1 | 34 ++++++++++++++++++++++
debian/manpages/cdfhdy3d.1 | 20 +++++++++++++
debian/manpages/cdfmean.1 | 36 ++++++++++++++++++++++++
debian/rules | 7 +++++
10 files changed, 328 insertions(+)
diff --git a/debian/bash.completion b/debian/bash.completion
new file mode 100644
index 0000000..9ac3037
--- /dev/null
+++ b/debian/bash.completion
@@ -0,0 +1,56 @@
+complete -W "-check -verbose" -f cdf16bit
+# ./cdf2levitusgrid2d <infile> <outfile> <var> . TODO: expand var from <infile>a
+# ./cdf2matlab : TODO: expand var from <infile>
+complete -W "-full -var -zeromean" -f cdfmean
+# TODO: More complete cdfmean possible
+complete -W "-file -f -var -v -lev -l -time -t -scale -zoom -z -fillzone -fz -raz_zone -rz -raz_below -set_below -fullstep -dumpzone -d \
+ -nicedumpzone -nd -replace -r -append -a -overwrite -o -log " -f cdfbathy
+complete -W "-full" -f cdfbn2
+complete -W "-full -ssh -ssh2" -f cdfbotpressure
+# cdfbottom <ncfile> T | U | V | F
+# cdfbottomsig T-file [zref]
+# cdfbti UVWT-file
+# cdfbuoyflx T-file RNF-file
+# cdfcensus T-file nlog [-zoom imin imax jmin jmax] ...'
+# ... [-klim kmin kmax] [-full] [-bimg] ... '
+# ... [-srange smin smax ds ] ...'
+# ... [-trange tmin tmax dt ] '
+complete -W "-klim -srange -trange -full -bimg" -f cdfcensus
+# cdfchgrid -f IN-file -var IN-var
+complete -W "-f -var" -f cdfchgrid
+# cdfclip -f IN-file -zoom imin imax jmin jmax [kmin kmax]
+complete -W "-f -zoom" -f cdfclip
+# cdfcmp -f1 IN-file1 -f2 IN-file2 -var IN-var ...'
+# ... [-lev kmin kmax ] [-zoom imin imax jmin jmax] ...'
+complete -W "-f1 -f2 -var -lev -zoom" -f cdfdmp
+# cdfmean filemask [imin imax jmin jmax kmin kmax]
+#i PRINT *,' usage : cdfcoloc -w root_weight -t gridT -trc TRC_file ...'
+# PRINT *,' ... -u gridU -v gridV [-l field list ] [-h]'
+complete -W "-w -t -trc -u -v -h" -f cdfcoloc
+# cdfconvert CLIPPER_tag CLIPPER_Confcase'
+# cdfcsp list_of_files
+# cdfcurl U-file V-file U-var V-var lev^
+# cdfdifmask mask1 mask2'
+# cdfdiv U-file V-file [ U-var V-var ] [ -full ]
+complete -W "-full " -f cdfdiv
+# cdfeke U-file U2-file V-file V2-file T2-file'
+# cdfets T-file
+# cdfimprovechk IN-var OBS-file REF-file TST-file
+# cdffindij xmin xmax ymin ymax [-c COOR-file] [-p point_type]
+complete -W "-c -p " -f cdffindij
+# cdffixtime -f IN-file -i initial date [-t tag] [-dt freq] ... '
+# ... [-keep ] [-leap] [ -noleap]'
+complete -W "-f -i -t -dt -keep -leap -noleap" -f cdffixtime
+# Usage : cdfflxconv YEAR config '
+# cdffracinv TRC-file [-inv INV-name]'
+complete -W "-inv " -f cdffracinv
+# usage : cdfgeostrophy T-file'
+# usage : cdfgeo-uv T-file'
+# usage : cdfgradT T-file'
+# usage : cdfhdy3d T-file'
+# cdfhdy T-file level1 level2
+# usage : cdfheatc T-file ...'
+# PRINT *,' ... [imin imax jmin jmax kmin kmax] [-full] '
+# PRINT *,' '
+# PRINT *,' PURPOSE :'
+complete -W " -full " -f cdfheatc
diff --git a/debian/cdftools.manpages b/debian/cdftools.manpages
new file mode 100644
index 0000000..322e81f
--- /dev/null
+++ b/debian/cdftools.manpages
@@ -0,0 +1 @@
+debian/manpages/cdf16bit.1
diff --git a/debian/manpages/cdf16bit.1 b/debian/manpages/cdf16bit.1
new file mode 100644
index 0000000..d125fad
--- /dev/null
+++ b/debian/manpages/cdf16bit.1
@@ -0,0 +1,53 @@
+.TH cdf16bit 1 CDFTOOLS
+
+.SH NAME
+cdf16bit - Convert 32-bit precision NetCDF files to 16-bit
+.SH SYNOPSIS
+32BIT-file [ -check ] [ -verbose]
+
+.SH INPUT
+32-BIT file \- A 32-bit precision NetCDF file.
+
+.SH OPTIONS
+.TP
+\fB\-check\fR
+control that the scale factors are adequate.
+.TP
+\fB\-verbose\fR
+give information level by level
+
+.SH OUTPUT
+.TP
+netcdf file: \fBcdf16bit.nc\fR
+variables : same names than in input file
+
+.SH SEE ALSO
+http://www.drakkar-ocean.eu/tools-misc/cdftools
+
+.SH AUTHOR
+J.-M. Molines.
+This manpage was written by Alastair McKinstry
+
+." INT *,' usage : cdf16bit 32BIT-file [ -check ] [ -verbose]'
+." INT *,' '
+." INT *,' PURPOSE :'
+." INT *,' Convert input 32 bit precision file into 16 bit'
+." INT *,' precision file using add_offset and scale_factor'
+." INT *,' '
+." INT *,' ARGUMENTS :'
+." INT *,' 32BIT-file : input 32 bit file to be converted'
+." INT *,' '
+." INT *,' OPTIONS :'
+." INT *,' [ -check ] : control than the scale factors are adequate'
+." INT *,' [ -verbose ] : give information level by level.'
+." INT *,' '
+." INT *,' REQUIRED FILES :'
+." INT *,' none '
+." INT *,' '
+." INT *,' OUTPUT : '
+." INT *,' netcdf file : ', TRIM(cf_out)
+." INT *,' variables : same names than in input file'i
+
+
+.SH REQUIRED FILES
+None
diff --git a/debian/manpages/cdf2levitusgrid2d.1 b/debian/manpages/cdf2levitusgrid2d.1
new file mode 100644
index 0000000..97596f5
--- /dev/null
+++ b/debian/manpages/cdf2levitusgrid2d.1
@@ -0,0 +1,40 @@
+.TH cdf2levitusgrid2d 1 CDFTOOLS
+
+.SH NAME cdf2levitusgrid2d \- Remap fields on Levitus2D 1x1 degree grid
+
+.SH SYNPOSIS
+ IN-file OUT-file VAR-name2D
+
+
+.SH SEE ALSO
+http://www.drakkar-ocean.eu/tools-misc/cdftools
+
+.SH AUTHOR
+J.-M. Molines.
+This manpage was written by Alastair McKinstry
+
+
+." PRINT *,' '
+." PRINT *,' PURPOSE :'
+." PRINT *,' remaps (bin) 2D high resolution (finer than 1x1 deg) '
+." PRINT *,' fields on Levitus 2D 1x1 deg grid '
+." PRINT *,' (does not work for vector fields) '
+." PRINT *,' It assumes that Levitus grid SW grid cell center '
+." PRINT *,' is (0.5W,89.5S) '
+." PRINT *,' '
+." PRINT *,' ARGUMENTS :'
+." PRINT *,' IN-file : netcdf input file '
+." PRINT *,' OUT-file : netcdf output file '
+." PRINT *,' VAR-name2D : input variable name for interpolation '
+." PRINT *,' '
+." PRINT *,' OPTIONS :'
+." PRINT *,' '
+." PRINT *,' REQUIRED FILES :'
+." PRINT *,' ',TRIM(cn_fhgr)
+." PRINT *,' ',TRIM(cn_fmsk)
+." PRINT *,' ',TRIM(cf_levitus_mask)
+." PRINT *,' '
+." PRINT *,' OUTPUT : '
+." PRINT *,' netcdf file : name given as second argument'
+." PRINT *,' variables : 2d_var_name'
+." STOP
diff --git a/debian/manpages/cdf2matlab.1 b/debian/manpages/cdf2matlab.1
new file mode 100644
index 0000000..3b66a8f
--- /dev/null
+++ b/debian/manpages/cdf2matlab.1
@@ -0,0 +1,32 @@
+.TH cdf2matlab 1 CDFTOOLS
+
+.SH NAME
+cdf2matlab \- Convert NEMO input file to a file with monotonically increasing longitudes.
+
+.SH SYNOPSIS
+cdf2matlab IN-file IN-var level
+
+
+.SH SEE ALSO
+http://www.drakkar-ocean.eu/tools-misc/cdftools
+
+.SH AUTHOR
+J.-M. Molines.
+This manpage was written by Alastair McKinstry
+
+." *,' '
+." *,' PURPOSE :'
+." *,' Convert global nemo input file (ORCA configurations) into'
+." *,' a file with monotonically increasing longitudes.'
+." *,' '
+." *,' ARGUMENTS :'
+." *,' IN-file : input model file.'
+." *,' IN-var : netcdf variable name to process.'
+." *,' level : level to process.'
+." *,' '
+." *,' REQUIRED FILES :'
+." *,' none'
+." *,' '
+." *,' OUTPUT : '
+." *,' netcdf file : ', TRIM(cf_out)
+." *,' variables : same name than in input file.'
diff --git a/debian/manpages/cdfbathy.1 b/debian/manpages/cdfbathy.1
new file mode 100644
index 0000000..8573e68
--- /dev/null
+++ b/debian/manpages/cdfbathy.1
@@ -0,0 +1,49 @@
+.TH cdfbathy 1 CDFTOOOLS
+
+.SH NAME
+cdfbathy/cdfvar \- Modify manual modification of Nemo CDF files
+
+
+." *,' usage : cdfbathy/cdfvar -f IN-file [options]'
+." *,' '
+." *,' PURPOSE :'
+." *,' Allow manual modification of the input file. Very convenient'
+." *,' for bathymetric files, can also be used with any model file'
+." *,' Keep a log.f90 file of the modifications for automatic reprocessing'
+." *,' '
+." *,' ARGUMENTS :'
+." *,' IN-file : original input file. The program works on a copy of the'
+." *,' original file (default)'
+." *,' '
+." *,' OPTIONS :'
+." 9999, ' -file (or -f ) : name of input file '
+." 9999, ' -var (or -v ) : name of cdf variable [default: Bathymetry]'
+." 9999, ' -lev (or -l ) : level to work with '
+." 9999, ' -time (or -t ) : time to work with '
+." 9999, ' -scale s : use s as a scale factor (divide when read the file)'
+." 9999, ' -zoom (or -z ) : sub area of the bathy file to work with (imin imax jmin jmax)'
+." 9999, ' -fillzone (or -fz ) : sub area will be filled with 0 up to the first coast line '
+." 9999, ' -raz_zone (or -raz ) : sub area will be filled with 0 up '
+." 9999, ' -raz_below depmin : any depth less than depmin in subarea will be replaced by 0 '
+." 9999, ' (or -rb depmin ) '
+." 9999, ' -set_below depmin : any depth less than depmin in subarea will be replaced by depmin '
+." 9999, ' (or -sb depmin ) '
+." 9999, ' -fullstep depmin : sub area will be reshaped as full-step, below depmin'
+." 9999, ' (or -fs depmin ) requires the presence of the file zgr_bat.txt (from ocean.output, eg )'
+." 9999, ' -dumpzone (or -d ) : sub area will be output to an ascii file, which can be used by -replace'
+." 9999, ' after manual editing '
+." 9999, ' -nicedumpzone : sub area will be output to an ascii file (nice output)'
+." 9999, ' (or -nd )'
+." 9999, ' -replace (or -r ) : sub area defined by the file will replace the original bathy'
+." 9999, ' -append (or -a ) : fortran log file (log.f90) will be append with actual modif'
+." 9999, ' Standard behaviour is to overwrite/create log file'
+." 9999, ' -overwrite (or -o ) : input bathy file will be used as output.'
+." 9999, ' Standard behaviour is to use a work copy of the original file'
+." 9999, ' (indexed from 01 to 99 if necessary ) '
+." 9999, ' -log logfile : log file for change (default is log.f90) '
+." *,' '
+." *,' OUTPUT : '
+." 9999, ' netcdf file : according to used options, if the original file is to be modified'
+." 9999, ' a sequence number is added at the end of the input file name, to keep'
+." 9999, ' modifications.'
+." *,' variables : same as input file'
diff --git a/debian/manpages/cdfbci.1 b/debian/manpages/cdfbci.1
new file mode 100644
index 0000000..d6c9b06
--- /dev/null
+++ b/debian/manpages/cdfbci.1
@@ -0,0 +1,34 @@
+.TH cdfbci 1 CDFTOOLS
+
+.SH NAME
+cdfbci \- Compute elements for analysing the baroclinic instability
+
+
+.SH SEE ALSO
+cdfmoyuvwt
+
+
+." *,' usage : cdfbci UVWT-file'
+." *,' '
+." *,' PURPOSE :'
+." *,' Compute elements for analysing the baroclinic instability'
+." *,' '
+." *,' ARGUMENTS :'
+." *,' UVWT-file : input file is produced by cdfmoyuvwt, and the mean'
+." *,' must be computed on a long-enough period for the '
+." *,' statistics to be meaningful. Points are on T grid.'
+." *,' '
+." *,' REQUIRED FILES :'
+." *,' Need ', TRIM(cn_fhgr) ,' file'
+." *,' '
+." *,' OUTPUT : '
+." *,' netcdf file : ', TRIM(cf_out)
+." *,' variables : 5 output variables'
+." *,' dTdx : zonal derivative of Tbar on T point (*1000)'
+." *,' dTdy : meridional derivative of Tbar on T point (*1000)'
+." *,' uT : anomaly of u times anomaly of T on T point'
+." *,' vT : anomaly of v times anomaly of T on T point'
+." *,' bci : transfert of energy for the baroclinic instability (*1000)'
+." *,' '
+." *,' SEE ALSO :'
+." *,' cdfmoyuvwt '
diff --git a/debian/manpages/cdfhdy3d.1 b/debian/manpages/cdfhdy3d.1
new file mode 100644
index 0000000..9f36924
--- /dev/null
+++ b/debian/manpages/cdfhdy3d.1
@@ -0,0 +1,20 @@
+ PRINT *,' usage : cdfhdy3d T-file'
+ PRINT *,' '
+ PRINT *,' PURPOSE :'
+ PRINT *,' Compute dynamic height anomaly from T-file given as argument.'
+ PRINT *,' '
+ PRINT *,' ARGUMENTS :'
+ PRINT *,' T-file : netcdf file with temperature and salinity.'
+ PRINT *,' '
+ PRINT *,' '
+ PRINT *,' REQUIRED FILES :'
+ PRINT *,' ',TRIM(cn_fmsk),' and ', TRIM(cn_fzgr)
+ PRINT *,' '
+ PRINT *,' OUTPUT : '
+ PRINT *,' netcdf file : ', TRIM(cf_out)
+ PRINT *,' variables : ', TRIM(cv_out),' ( m )'
+ PRINT *,' '
+ PRINT *,' SEE ALSO :'
+ PRINT *,' cdfhdy'
+ PRINT *,' '
+
diff --git a/debian/manpages/cdfmean.1 b/debian/manpages/cdfmean.1
new file mode 100644
index 0000000..bb0a963
--- /dev/null
+++ b/debian/manpages/cdfmean.1
@@ -0,0 +1,36 @@
+ usage : cdfmean IN-file IN-var T|U|V|F|W [imin imax jmin jmax kmin kmax]
+ ... [-full] [-var] [-zeromean]
+
+ PURPOSE :
+ Computes the mean value of the field (3D, weighted). For 3D fields,
+ a horizontal mean for each level is also given. If a spatial window
+ is specified, the mean value is computed only in this window.
+
+ ARGUMENTS :
+ IN-file : input netcdf file.
+ IN-var : name of netcdf variable to work with.
+ T|U|V|F|W : position of cdfvar on the C-grid
+
+ OPTIONS :
+ [imin imax jmin jmax kmin kmax] : spatial windows where mean value
+ is computed:
+ if imin = 0 then ALL i are taken
+ if jmin = 0 then ALL j are taken
+ if kmin = 0 then ALL k are taken
+ [ -full ] : compute the mean for full steps, instead of default
+ partial steps.
+ [ -var ] : also compute the spatial variance of cdfvar
+ [ -zeromean ] : create a file with cdfvar having a zero spatial mean.
+
+ REQUIRED FILES :
+ Files mesh_hgr.nc, mesh_zgr.nc, mask.nc
+
+ OUTPUT :
+ - netcdf file : cdfmean.nc
+ variables : mean_cdfvar, mean_3D_cdfvar
+ [var_cdfvar, var_3D_cdfvar, in case of -var]
+ - netcdf file : zeromean.nc [ in case of -zeromean option]
+ variables : cdfvar
+ - ASCII files : cdfmean.txt
+ [ cdfvar.txt, in case of -var ]
+ - all output on ASCII files are also sent to standard output.
diff --git a/debian/rules b/debian/rules
index 02543cf..f1b0b44 100755
--- a/debian/rules
+++ b/debian/rules
@@ -6,6 +6,8 @@
%:
dh $@
+DESTDIR:=debian/cdftools
+
override_dh_auto_configure:
ln -sf Macrolib/macro.gfortran make.macro
mkdir bin
@@ -18,3 +20,8 @@ override_dh_auto_clean:
rm -f make.macro *.mod *.o DOC/*.pdf DOC/*.docs
rm -fr bin
$(MAKE) -C DOC clean
+
+override_dh_auto_install:
+ dh_auto_install
+ mkdir -p $(DESTDIR)/etc/bash_completion.d
+ cp debian/bash.completion $(DESTDIR)/etc/bash_completion.d/cdftools
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/cdftools.git
More information about the debian-science-commits
mailing list