Author: miguel_tremblay
Date: Fri Sep 26 16:47:23 2014
New Revision: 379
URL: http://svn.gna.org/viewcvs/metro?rev=379&view=rev
Log:
Addition of the options --enable-sunshadow and --sunshadow-method method.
Options are now in alphabetical order.
Add the GPLv2 in the Copyright section.
Modified:
metro/trunk/usr/share/man/man1/metro.1
Modified: metro/trunk/usr/share/man/man1/metro.1
URL:
http://svn.gna.org/viewcvs/metro/metro/trunk/usr/share/man/man1/metro.1?rev=379&r1=378&r2=379&view=diff
==============================================================================
--- metro/trunk/usr/share/man/man1/metro.1 (original)
+++ metro/trunk/usr/share/man/man1/metro.1 Fri Sep 26 16:47:23 2014
@@ -3,35 +3,28 @@
metro \- METRo is a road weather forecast software from Environment Canada.
.SH SYNOPSIS
.B metro
-[\-\-version] [\-\-help] [\-\-roadcast-start-date date] [\-\-input\-forecast
filename] [\-\-input\-observation filename] [\-\-input\-station filename]
[\-\-output\-forecast filename] [\-\-output\-roadcast filename] [\-\-config
filename] [\-\-generate\-config filename] [\-\-log\-file filename]
[\-\-verbose\-level level] [\-\-selftest] [\-\-silent] [\-\-lang]
[\-\-use\-solarflux\-forecast] [\-\-use\-infrared\-forecast]
[\-\-use\-anthropogenic\-flux] [\-\-use-sst-sensor-depth]
[--output-subsurface-levels]
+[\fB\-\-version\fR] [\fB\-\-help\fR] [\fB\-\-roadcast-start-date\fR
\fIdate\fR] [\fB\-\-input\-forecast\fR \fIfilename\fR]
[\fB\-\-input\-observation\fR \fIfilename\fR] [\fB\-\-input\-station\fR
\fIfilename\fR] [\fB\-\-output\-forecast\fR \fIfilename\fR]
[\fB\-\-output\-roadcast\fR \fIfilename\fR] [\fB\-\-config\fR \fIfilename\fR]
[\fB\-\-generate\-config\fR \fIfilename\fR] [\fB\-\-log\-file\fR
\fIfilename\fR] [\fB\-\-verbose\-level\fR \fIlevel\fR] [\fB\-\-selftest\fR]
[\fB\-\-silent\fR] [\fB\-\-lang\fR \fI[fr|en]\fR]
[\fB\-\-use\-solarflux\-forecast\fR] [\fB\-\-use\-infrared\-forecast\fR]
\fB[\-\-use\-anthropogenic\-flux\fR] [\fB\-\-use-sst-sensor-depth\fR]
[\fB\-\-output-subsurface-levels\fR] [\fB\-\-enable\-sunshadow
[\fB\-\-sunshadow\-method \fImethod\fR]\fR]
.SH DESCRIPTION
With the help of observations provided by roads weather stations (road weather
information system, RWIS) and the atmospheric forecast, METRo can predict the
roads conditions with particular interest such as: freezing rain, accumulation
of snow, frost or defrost soil.
+
+
+
.SH OPTIONS
+
+
+
.TP
-.B
-\-\-version
-output version information and exit
+.B \-\-config filename
+If a configuration file is provided, the options in this file can be used
instead of those given in command line. To generate a file with the requested
format, see the option \-\-generate\-config .
+.TP
+.B \-\-enable\-sunshadow
+Optional. METRo uses sun-shadow algorithm to determine if the road is exposed
to sun at a particular time. There is two methods to compute this shadow. See
the option \-\-sunshadow\-method for more details. The station XML file
contains the information about the visible elevation of the road under the
'<visible\-horizon>' element. The sun-shadow routine requires <azimuth>,
<elevation> pairs being ordered by growing azimuths values and also uniform
step in azimuth is required (i.e, each neighbour azimuth values are displaced
by same distance), otherwise it can give a wrong results.
.TP
.B \-\-help
Display a list of command line options.
.TP
-.B \-\-roadcast-start-date date
-Optionnal. If this argument is not present, the date of the last observation
is used. Date of the first roadcast. The format is ISO 8601. See
http://en.wikipedia.org/wiki/ISO_8601 for further details.
-.TP
-.B \-\-use-solarflux-forecast
-Optionnal. Use this argument if you want to provide the solar flux in the
atmospheric forecast file instead of a theoretical flux based on cloud cover.
The tag for solar flux in forecast file is '<sf>'.
-.TP
-.B \-\-use-infrared-forecast
-Optionnal. Use this argument if you want to provide the infra-fred flux in the
atmospheric forecast file instead of a theoretical flux based on cloud cover.
The tag for infra-red flux in forecast file is '<ir>'.
-.TP
-.B \-\-use-anthropogenic-flux
-Optionnal. Use this argument if you want to provide the anthropogenic flux in
the atmospheric forecast file instead of using the default value of 10 W/m².
The tag for anthropogenic flux in forecast file is '<fa>'.
-.TP
-.B \-\-use-sst-sensor-depth
-Optionnal. Use this argument if the subsurface sensor is not at 0.4 m from the
surface. This value can be between 0.2 m and 0.6 m. The modified value should
be in the station XML config file in the element '<sst-sensor-depth>, included
in the <header> node.
-.TP
-.B \-\-output\-subsurface\-levels
-Optionnal. Put in the output roadcast all the temperature for the subsurfaces
levels, 19 levels for roads or a uniform grid at every cm for bridges. WARNING:
Using this option slow down METRo by a factor of 2.
+.B \-\-generate\-config filename
+Generate an empty config file. You can then fill the options that will be
used if the option \-\-config is set to filename on a subsequent call to metro.
.TP
.B \-\-input\-forecast filename
Set where is the atmosperic forecast file.
@@ -42,17 +35,47 @@
.B \-\-input\-station filename
filename is where the configuration file of the RWIS station is.
.TP
+.B\-\-lang fr|en
+Choose the language of message for METRo. Default is english. Only French is
currently implemented as other language.
+.TP
+.B \-\-log\-file filename
+Set the path of the metro log file.
+.TP
.B \-\-output\-forecast filename
Set where the roadcast of METRo will be written.
.TP
-.B \-\-config filename
-If a configuration file is provided, the options in this file can be used
instead of those given in command line. To generate a file with the requested
format, see the option \-\-generate\-config .
+.B \-\-output\-subsurface\-levels
+Optional. Put in the output roadcast all the temperature for the subsurfaces
levels, 19 levels for roads or a uniform grid at every cm for bridges. WARNING:
Using this option slow down METRo by a factor of 2.
.TP
-.B \-\-generate\-config filename
-Generate an empty config file. You can then fill the options that will be
used if the option \-\-config is set to filename on a subsequent call to metro.
+.B \-\-roadcast-start-date date
+Optional. If this argument is not present, the date of the last observation
is used. Date of the first roadcast. The format is ISO 8601. See
http://en.wikipedia.org/wiki/ISO_8601 for further details.
.TP
-.B \-\-log\-file filename
-Set the path of the metro log file.
+.B \-\-selftest
+Execute a test with default files provided with metro. The default command
line is:
+
+metro \-\-roadcast-start-date 2004\-01\-30T20:00Z \-\-input\-forecast
../../data/forecast/forecast_selftest.xml \-\-input\-observation
../../data/observation/observation_selftest.xml \-\-input\-station
../data/station/station_selftest.xml \-\-output\-forecast
../../data/roadcast/roadcast_selftest.xml \-\-verbose\-level 5
+.TP
+.B\-\-silent
+Do not write in the standard output.
+.TP
+.B \-\-sunshadow\-method
+Optional. Only used if \-\-enable\-sunshadow is set. 'method' takes the value
of [1|2]. If no value is given, '1' is used as the default value.
+ 1 = Basic method (default). It sets solar flux to zero when Sun is below
+ visible horizon
+ 2 = Enhanced method. Replaces global solar flux with its diffuse component
+ when Sun is below visible horizon.
+.TP
+.B \-\-use-anthropogenic-flux
+Optional. Use this argument if you want to provide the anthropogenic flux in
the atmospheric forecast file instead of using the default value of 10 W/m².
The tag for anthropogenic flux in forecast file is '<fa>'.
+.TP
+.B \-\-use-infrared-forecast
+Optional. Use this argument if you want to provide the infra-fred flux in the
atmospheric forecast file instead of a theoretical flux based on cloud cover.
The tag for infra-red flux in forecast file is '<ir>'.
+.TP
+.B \-\-use-sst-sensor-depth
+Optional. Use this argument if the subsurface sensor is not at 0.4 m from the
surface. This value can be between 0.2 m and 0.6 m. The modified value should
be in the station XML config file in the element '<sst-sensor-depth>, included
in the <header> node.
+.TP
+.B \-\-use-solarflux-forecast
+Optional. Use this argument if you want to provide the solar flux in the
atmospheric forecast file instead of a theoretical flux based on cloud cover.
The tag for solar flux in forecast file is '<sf>'.
.TP
.B \-\-verbose\-level level
Select the verbose level of the logged messages of metro.
@@ -72,18 +95,16 @@
4- Debug
.RE
.TP
-.B \-\-selftest
-Execute a test with default files provided with metro. The default command
line is:
-.br metro --model-start-y 2004 --model-start-m 01 --model-start-d 30
--model-start-h 20 --input-forecast ../../data/forecast/forecast_selftest.xml
--input-observation ../../data/observation/observation_selftest.xml
--input-station ../data/station/station_selftest.xml --output-forecast
../../data/roadcast/roadcast_selftest.xml --verbose-level 5
-.TP
-.B\-\-silent
-Do not write in the standard output.
-.TP
-.B\-\-lang fr|en
-Choose the language of message for METRo. Default is english. Only French is
currently implemented as other language.
+.B
+\-\-version
+output version information and exit
+
+
.SH AUTHOR
Written by Miguel Tremblay, Francois Fortin, Yves Delage and Louis-Philippe
Crevier.
.SH COPYRIGHT
-COPYRIGHT \(co 2004, Service Meteorologique du Canada, Environnement Canada.
See documentation at http://documentation.wikia.com/wiki/METRo for details.
+COPYRIGHT \(co 2004, Service Meteorologique du Canada, Environnement Canada.
See documentation at http://documentation.wikia.com/wiki/METRo for details.
Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU General Public License, Version 2.
+
+
.SH REPORTING BUGS
Report bugs to <metro-develop...@gna.org>
_______________________________________________
Metro-commits mailing list
Metro-commits@gna.org
https://mail.gna.org/listinfo/metro-commits
