Log In | Get Help   
Home My Page Projects Code Snippets Project Openings Mareframe
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files
[mareframe] Annotation of /trunk/gadget/gadget.1
[mareframe] / trunk / gadget / gadget.1 Repository:
ViewVC logotype

Annotation of /trunk/gadget/gadget.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (view) (download)

1 : agomez 1 .TH "Gadget" "1" "2.1.06" "James Begley" ""
2 :     .SH "NAME"
3 :     .LP
4 :     gadget
5 :     .br
6 :     \fBG\fRlobally applicable \fBA\fRrea \fBD\fRisaggregated \fBG\fReneral \fBE\fRcosystem \fBT\fRoolbox
7 :     .SH "SYNTAX"
8 :     .LP
9 :     gadget [\fIoptions\fP]
10 :     .SH "DESCRIPTION"
11 :     .LP
12 :     Gadget is a flexible and powerful tool for creating ecosystem models. The program was developed for modelling marine ecosystems in a fisheries management and biology context, however there is nothing in the program that restricts it to fish, and models have been developed to examine marine mammal populations
13 :    
14 :     .LP
15 :     Gadget can run complicated statistical ecosystem models, which take many features of the ecosystem into account. Gadget works by running an internal model based on many parameters, and then comparing the data from the output of this model to real data to get a goodness\-of\-fit likelihood score. The parameters can then be adjusted, and the model re\-run, until an optimum is found, which corresponds to the model with the lowest likelihood score.
16 :    
17 :     .LP
18 :     Gadget allows you to include a number of features into your model: One or more species, each of which may be split into multiple stocks; multiple areas with migration between areas; predation between and within species; maturation; reproduction and recruitment; multiple commercial and survey fleets taking catches from the populations.
19 :     .SH "OPTIONS"
20 :     .LP
21 :     Options for running Gadget:
22 :     .TP
23 :     \fB\-l\fR
24 :     perform a likelihood (optimising) model run
25 :     .TP
26 :     \fB\-s\fR
27 :     perform a single (simulation) model run
28 :     .TP
29 :     \fB\-n\fR
30 :     perform a network run (using paramin)
31 :     .TP
32 :     \fB\-v \-\-version\fR
33 :     display version information and exit
34 :     .TP
35 :     \fB\-h \-\-help\fR
36 :     display help screen and exit
37 :    
38 :     .LP
39 :     Options for specifying the input to Gadget models:
40 :     .TP
41 :     \fB\-i <filename>\fR
42 :     read model parameters from <filename>
43 :     .TP
44 :     \fB\-opt <filename>\fR
45 :     read optimising parameters from <filename>
46 :     .TP
47 :     \fB\-main <filename>\fR
48 :     read model information from <filename> (default "main")
49 :     .TP
50 :     \fB\-m <filename>\fR
51 :     read other commandline parameters from <filename>
52 :    
53 :     .LP
54 :     Options for specifying the output from Gadget models:
55 :     .TP
56 :     \fB\-p <filename>\fR
57 :     print model parameters to <filename> (default "params.out")
58 :     .TP
59 :     \fB\-o <filename>\fR
60 :     print likelihood output to <filename>
61 :     .TP
62 :     \fB\-print <number>\fR
63 :     print \-o output every <number> iterations
64 :     .TP
65 :     \fB\-precision <number>\fR
66 :     set the precision to <number> in output files
67 :    
68 :     .LP
69 :     Options for debugging Gadget models:
70 :     .TP
71 :     \fB\-log <filename>\fR
72 :     print logging information to <filename>
73 :     .TP
74 :     \fB\-printinitial <filename>\fR
75 :     print initial model information to <filename>
76 :     .TP
77 :     \fB\-printfinal <filename>\fR
78 :     print final model information to <filename>
79 :    
80 :     .SH "ENVIRONMENT VARIABLES"
81 :     .LP
82 :     .TP
83 :     \fBGADGET_WORKING_DIR\fP
84 :     Specifies the working directory, used for the output from Gadget (defaults to current directory if not specified)
85 :     .TP
86 :     \fBGADGET_DATA_DIR\fP
87 :     Specifies the data directory, used for the input to Gadget (defaults to current directory if not specified)
88 :     .SH "CONTACT"
89 :     .LP
90 :     For help on running Gadget, constructing Gadget models and understanding the output contact <gadgethelp@hafro.is>
91 :     .LP
92 :     There is also a Gadget user mailing list set up <gadgetusers@hafro.is>
93 :     .LP
94 :     Send software bug reports to James Begley <james@hafro.is>
95 :     .LP
96 :     Documentation written by James Begley <james@hafro.is>
97 :     .SH "SEE ALSO"
98 :     .LP
99 :     Gadget web page <http://www.hafro.is/gadget>

root@forge.cesga.es
ViewVC Help
Powered by ViewVC 1.0.0  

Powered By FusionForge