rm exe
[unres.git] / doc / unresga.1
1 .TH unresga 1    "September 26, 2011" "version 0.1" "USER COMMANDS"
2 .SH NAME
3 unresga \- finds optimal parameters for UNRES force-field by using genetic algorithm (GA)
4 .SH SYNOPSIS
5 .B unresga
6 .SH DESCRIPTION
7 This utility optimizes UNRES force-fields parameters (weights) by using genetic algorithm.
8 Curentely there are 19 parameters that can be optimized, altough not all of them are used (WLONG for instance).
9 These paremeters are defined in thó MD inputs as WLONG, WSCP, WELEC, WBOND, WANG, WSCLOC, WTOR, WTORD, WCORRH, WCORR4, WCORR5, WCORR6, WEL_LOC, WTURN3, WTURN4, WTURN6, WVDWPP, WHPB, WSCCOR.
10 The min and max boundries for these parameters are defined in the 
11 .I src/GA.inc
12 file.
13
14
15 .SH FILES
16 .IP unresga.inp 
17 This is the main configuration file 
18 .IP unresga.log 
19 This is the automaticly generated log file. Use it for troubleshooting.
20 .IP unresga.state 
21 state file used by the main program to manage input generation between MREMD, WHAM, ZSCORE steps. You shouldn't modify it unless something went terrible wrong and you realy know what you are doing...
22
23 .SH unresga.inp structure
24 The 
25 .I unresga.inp
26 file consists of 
27 .B key=value1 value2 ... valueX
28 entries. Key entries must be uppercase or lowercase, but not mixed-type. An example input file should look like this:   
29
30 .nf
31 pdb=1LE1.pdb 1L2Y.pdb
32 .br
33 alg=csa
34 .br
35 generations=50 
36 .br
37 cicutoff=5.0
38 .br
39 population=4
40 .br
41 whamtemplate=1LE1_wham.tpl 1L2Y_wham.tpl
42 .br
43 mremdtemplate=1LE1_mremd.tpl 1L2Y_mremd.tpl
44 .br
45 scripts=startwham.mat startmremd.mat
46 .fi
47
48 .IP PDB= 
49 Posible values are the reference PDB files used for calculations. At least one file should be specified. Maximum number of PDB files is set by variable maxnpdb in 
50 .I src/common.inc
51 (default 10)
52 .IP ALG=
53 Value defines witch algoritm should be used in genetic part. Values are: simple, better, betterv2, csa, cluster. 
54 .IP GENERATIONS=
55 Value sets maximum number of iterations for the genetic algorithm part.
56 .IP POPULATION=
57 Sets the size of bank population. Actual size of population is this value multiplied by value of the BANK_MULTIPLIER constant set in 
58 .I src/GA.inc
59 (default 4) 
60 .IP WHAMTEMPLATE=
61 Set the input template for generationg WHAM inputs. Number of templates should be equal to the number of PDB files.
62 .IP MREMDTEMPLATE=
63 Same as above but for MREMD inputs.  
64
65 .IP SCRIPTS=
66 Copy aditional files (shell scripts) for current input. This is obsolete and curentely disabled. 
67
68
69 .SH AUTHOR
70 Dawid Jagiela  (lightnir (at) chem.univ.gda.pl)