|
|
| Line 10: |
Line 10: |
| <span style="color: maroon;">rst-wham-2d</span> | | <span style="color: maroon;">rst-wham-2d</span> |
|
| |
|
| ::<span style="color: purple;">Px</span><span style="color: blue;"><nowiki>[=0|pi|val]</nowiki></span> | | ::<span style="color: purple;">Px</span><span style="color: blue;"><nowiki>[=0|pi|val]</nowiki></span><span style="color: purple;">hist_min_x hist_max_x num_bins_x</span> |
| <span style="color: purple;">hist_min_x hist_max_x num_bins_x</span> | |
|
| |
|
| ::<span style="color: purple;">Py</span><span style="color: blue;"><nowiki>[=0|pi|val]</nowiki></span> | | ::<span style="color: purple;">Py</span><span style="color: blue;"><nowiki>[=0|pi|val]</nowiki></span><span style="color: purple;">hist_min_y hist_max_y num_bins_y</span> |
| <span style="color: purple;">hist_min_y hist_max_y num_bins_y</span> | |
|
| |
|
| ::<span style="color: purple;">tol temperature numpad metadatafile freefile usemask</span> | | ::<span style="color: purple;">tol temperature numpad metadatafile freefile usemask</span> |
| Line 26: |
Line 24: |
|
| |
|
| {| style="margin-left: 2em; width: 75%;" | | {| style="margin-left: 2em; width: 75%;" |
| | | The command line arguments largely have the same meaning as they do for the one dimensional wham program. |
| |- style="vertical-align: top;"
| |
| | <span style="color: purple;"><nowiki>P|Ppi|Pval</nowiki></span><br/>
| |
| <span style="margin-left: 30px;">The first (optional) argument specifies the periodicity of the reaction coordinate. For a nonperiodic reaction coordinate (a distance, for example), it should be left out. "P" means that the reaction coordinate has a periodicity of 360, appropriate for angles. "Ppi" specifies a periodicity of 2*pi, appropriate for angles measured in radians. "Pval" specifies periodicty of some arbitrary amount, val, which should be an integer or floating point number. For example, "P180.0" would be appropriate for an angle with twofold symmetry.</span>
| |
| |- style="vertical-align: top; background-color: #e6e6e6;"
| |
| | <span style="color: purple;">hist_min hist_max</span><br/>
| |
| <span style="margin-left: 30px;">Specify the boundaries of the histogram. As a rule, all data points outside the range (hist_min, hist_max) are silently ignored. The only exception is that if an entire trajectory is outside the range, the program halts with an error message. The solution is to remove that file from the metadata file. hist_min and hist_max should be floating point numbers. </span>
| |
| |- style="vertical-align: top;"
| |
| | <span style="color: purple;">num_bins</span><br/>
| |
| <span style="margin-left: 30px;">Specifies the number of bins in the histogram, and as a result the number of points in the final PMF. It should be an integer.</span>
| |
| |- style="vertical-align: top; background-color: #e6e6e6;"
| |
| | <span style="color: purple;">tol</span><br/>
| |
| <span style="margin-left: 30px;">tol is the convergence tolerance for the WHAM calculations. Specifically, the WHAM iteration is considered to be converged when no Fi value for any simulation window changes by more than tol on consecutive iterations. As the program runs, it prints the average change in the F values for the most recent iteration. Obviously, this number will be smaller than tol before the computation converges, because convergence is triggered by the largest change as opposed to the average.</span>
| |
| |- style="vertical-align: top;"
| |
| | <span style="color: purple;">temperature</span><br/>
| |
| <span style="margin-left: 30px;">temperature is a floating point number representing the temperature in Kelvin at which the weighted histogram calculation is performed. This does not have to be the temperature at which the simulations were performed (see below for discussion). </span>
| |
| |- style="vertical-align: top; background-color: #e6e6e6;"
| |
| | <span style="color: purple;">numpad</span><br/>
| |
| <span style="margin-left: 30px;">numpad specifies the number of "padding" values that should be printed for periodic PMFs. This number should be set to 0 for aperiodic reaction coordinates. It doesn't actually affect the calculation in any way. Rather, it just alters the final printout of the free energy, to make plotting of periodic reaction coordinates simpler. This is more important for wham-2d than wham.</span>
| |
| |- style="vertical-align: top;" | | |- style="vertical-align: top;" |
| | <span style="color: purple;">metadatafile</span><br/> | | | <span style="color: purple;">Px (Py)</span><br/> |
| <span style="margin-left: 30px;">metadatafile specifies the name of the metadata file. The format of this file is described below.</span> | | <span style="margin-left: 30px;">The periodicity arguments are not optional. |
| | "Px" by itself indicates that the first dimension of the reaction coordinate has a period of 360. "Px=0" turns off periodicity. "Px=pi" specifies a period of 2*pi, and "Px=val" allows you to choose an arbitrary value for the period.</span> |
| |- style="vertical-align: top; background-color: #e6e6e6;" | | |- style="vertical-align: top; background-color: #e6e6e6;" |
| | <span style="color: purple;">freefile </span><br/> | | | <span style="color: purple;">hist_min_x hist_max_x num_bins_x</span><br/> |
| <span style="margin-left: 30px;">freefile is the name used for the file containing the final PMF and probability distribution.</span> | | <span style="margin-left: 30px;">behave exactly like hist_min, hist_max, and num_bins do in the 1 dimensional program. Py, hist_min_y, etc., behave the same as Px, hist_min_x, etc., except they control the second coordinate of the PMF.</span> |
| |- style="vertical-align: top;" | | |- style="vertical-align: top;" |
| | <span style="color: purple;">num_MC_trials randSeed</span><br/> | | | <span style="color: purple;">use_mask</span><br/> |
| <span style="margin-left: 30px;">num_MC_trials and randSeed (Optional) are both related to the performance of Monte Carlo bootstrap error analysis. If these values are not supplied, error analysis is not performed. num_MC_trials should be an integer specifying the number of fake data sets which should be generated. randSeed is an integer which controls the random number seed - the value you pick should be irrelevant, but I let the user set it primarily for debugging purposes.</span> | | <span style="margin-left: 30px;">expects an integer value, and if its values is non-zero turns on the automasking feature, which causes bins for which there is no sample data to be excluded from the wham calculation.</span> |
| |} | | |} |
|
| |
|