update help files

Author: github-actions[bot]

GSASII/help/commontreeitems.html

@@ -410,6 +410,21 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Restraints">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#restraint-types" class="md-nav__link">
+    <span class="md-ellipsis">
+      Restraint types
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
         <li class="md-nav__item">
@@ -1440,6 +1455,21 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Restraints">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#restraint-types" class="md-nav__link">
+    <span class="md-ellipsis">
+      Restraint types
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
         <li class="md-nav__item">
@@ -1516,7 +1546,7 @@ <h2 id="controls">Controls</h2>
 <li><strong>Min delta-M/M</strong> - A refinement will stop when the change in the minimization function, <em>M</em>,  <span class="arithmatex">\( (M=\sum[w(I_o-I_c)^2]) \)</span> is less than this value. The allowed range is <span class="arithmatex">\(10^{-9}\)</span> to 1.0, with a default of 0.001. A value of 1.0 stops the refinement after a single cycle. Values less than <span class="arithmatex">\(10^{-4}\)</span> cause refinements to continue even if there is no meaningful improvement.</li>
 <li><strong>Max cycles</strong> - This determines the maximum number of refinement cycles that will be performed. This is used only with the "analytical Hessian" and "Hessian SVD" minimizers.</li>
 <li><strong>Initial lambda</strong> - Note that here λ is the Marquardt coefficient, where a weight of 1+λ is applied to the diagonal elements of the Hessian. When λ is large, this down-weights the significance of the off-diagonal terms in the Hessian. Thus, when λ is large, the refinement is effectively one of steepest-descents, where correlation between variables is ignored. Note that steepest-descents minimization is typically slow and may not always find the local minimum. This is only used when with the "analytical Hessian" minimizer is selected.</li>
-<li><strong>SVD zero tolerance</strong> - This determines the level where SVD considers deivative values to be the same. Default is <span class="arithmatex">\(10^{-6}\)</span>. Make this larger when problems occur due to correlation. This is used only with the "analytical Hessian" and "Hessian SVD" minimizers.</li>
+<li><strong>SVD zero tolerance</strong> - This determines the level where SVD considers derivative values to be the same. Default is <span class="arithmatex">\(10^{-6}\)</span>. Make this larger when problems occur due to correlation. This is used only with the "analytical Hessian" and "Hessian SVD" minimizers.</li>
 <li><strong>Initial shift factor</strong> - This provides an initial scaling ("damping") for the first cycle of refinement. Only available for "analytic Jacobian" and "numeric" minimizers. </li>
 </ul>
 </li>
@@ -1627,7 +1657,8 @@ <h3 id="sequential-refinement-constraints">Sequential Refinement Constraints</h3
 <p>Also included when sequential refinement is selected is a menu button labeled "Selected histogram." With this it is possible to look at constraint problems when processing a specific histogram.</p>
 <p><a name="Restraints"></a></p>
 <h2 id="restraints">Restraints</h2>
-<p>This window shows the restraints to be used in a refinement for each phase (if more than one). It is organized into several tabbed pages, one page for each type of restraint. Restraints are developed for an individual phase and act as additional observations to be "fitted" during the refinement.</p>
+<p>This window shows the restraints to be used in a refinement for each phase (if more than one). It is organized into several tabbed pages, one page for each type of restraint. Restraints are developed for an individual phase and act as additional observations to be "fitted" during the refinement. </p>
+<p>Note that a restraint "pushes" a refinement towards a target value, but does not require that to happen (unlike a constraint). The strength of the "push" is dependent on the weighting factor and the "esd" used on the target value. The ideal use of a restraint is for an aspect of a structure that is not well-determined by the data. In this case, when the weighting of a restraint is dropped, the value of the restrained parameter may move considerably from the target value, but the quality of the fit (noted by the Rietveld plot, R-factor, reduced <span class="arithmatex">\(\chi^2\)</span>, etc.) is not expected to change very much. If one places a restraint that is not consistent with the model (<em>e.g.</em> is wrong), then the fit will improve significantly as the weight is decreased. Such feedback is not possible with a constraint. </p>
 <H3 style="color:blue;font-size:1.1em">What can I do here?</H3>
 
 <ul>
@@ -1649,6 +1680,15 @@ <H3 style="color:blue;font-size:1.1em">What can I do here?</H3>
 </ul>
 </li>
 </ul>
+<h3 id="restraint-types">Restraint types</h3>
+<ul>
+<li><strong>Bond</strong>: Defines restraints with a target distance between pairs of atoms (which are typically bonded, but this is not required). Atom pairs to be restrained are set by performing a search and then selecting the pairs to be used. </li>
+<li><strong>Angle</strong>:  Defines restraints with a target angle for a set of three atoms. Atoms to be used are located via a search and selection. </li>
+<li><strong>Plane</strong>: Used to restrain selected atoms to be approximately co-planar. This is most commonly used for macromolecular crystallography. </li>
+<li><strong>Chiral</strong>: Defines a chiral volume restraint. This is unlikely to be used other than for macromolecular crystallography. </li>
+<li><strong>Chem. Comp.</strong>: This is of use when "Frac" parameters (atom occupancies) are refined. This option allows a variety of different types of restraints to be created. More than one chemical composition restraint can be defined for a phase. Examples of how this might be used would be to "push" refinement towards an expected composition, to encourage charge balance or to conserve valences. </li>
+<li><strong>General</strong>: This allows a quantity to be restrained that is computed from a user-supplied equation, based on GSAS-II parameters. Thus, one can create any type of restraint that is desired. This restraint is used by supplying a Python equation and then to define which GSAS-II parameter is associated with each variable in the Python equation. One also supplies the target value for the restraint. Note that it is possible to use externally defined functions that contain "if" statements, which allows restraints that enforce minimum or maximum quantities rather than target values to be defined. </li>
+</ul>
 <p><a name="Rigidbodies"></a>
 <a name="Rigid_bodies"></a></p>
 <h2 id="rigid-bodies">Rigid bodies</h2>

GSASII/help/index.html

@@ -1288,14 +1288,17 @@
 <!--- Don't change the HTML version of this file; edit the .md version -->
 <p><a name="HelpIntro"></a> </p>
 <h1 id="help-for-gsas-ii">Help for GSAS-II</h1>
-<p>This and the subsequent web pages provide documentation for the
-GSAS-II graphical user interface (GUI). The information is organized
+<p>This and the web pages referenced below, provide documentation for use
+of the GSAS-II graphical user interface (GUI). The information is organized
 largely to follow the different sections of the GUI and is usually
-accessed via the "Help" features in GSAS-II. Help on specific sections
-of GSAS-II can be accessed from the yellow "?" button in the upper
-right corner of the data window. Access to specific help information 
-is also offered on the graphics
-window and in other locations of the program. </p>
+accessed via the "Help" features in GSAS-II: Help on specific sections
+of GSAS-II can be accessed from the "?" button (yellow on some computers) in the upper
+right corner of the data window, or from the Help command. The GSAS-II
+graphics window and in other locations of the program also offer
+access to context-specific help information.</p>
+<p>A single file containing all GSAS-II web pages is available <a href="https://advancedphotonsource.github.io/GSAS-II-tutorials/docs/GSASII-help.pdf">as a PDF
+document</a>
+(note: ~100 pages, please don't print it.)</p>
 <p><a name="Index"></a> 
 An index on the topics covered in these help pages is given below. </p>
 <ol>
@@ -1308,8 +1311,8 @@ <h1 id="help-for-gsas-ii">Help for GSAS-II</h1>
 </ol>
 </li>
 <li><a href="mainmenu.html">Main menu contents</a></li>
-<li>Data tree entries and their use (<a href="datatree.html">overview</a>)<ol>
-<li><a href="commontreeitems.html">Universal data tree</a> items <ul>
+<li><a href="datatree.html">Data tree entries: overview</a><ol>
+<li><a href="commontreeitems.html">Universal data tree items</a> <ul>
 <li><a href="commontreeitems.html#Notebook">Notebook</a> </li>
 <li><a href="commontreeitems.html#Controls">Controls and settings</a> </li>
 <li><a href="commontreeitems.html#Covariance">Covariance and fit results</a> </li>

GSASII/help/mainmenu.html

@@ -1512,7 +1512,8 @@ <h2 id="calculate-menu"><strong>Calculate</strong> Menu</h2>
 <p><strong>Setup PDFs</strong> - This is the first step in computing a pair distribution function (PDF). This creates the controls for each powder pattern selected in the dialog box, but does not compute the PDF, which must be done from <a href="pairdistribution.html">PDF tree entries</a>. See <a href="pairdistribution.html#PDF_Controls">PDF Controls</a>  for information on the PDF input.</p>
 </li>
 <li>
-<p><strong>View LS parms</strong> - This shows a dialog box where the status and value of every parameter used in your project can be viewed. The parameter names are of the form <code>p:h:name:id</code> where 'p' is the phase index, 'h' is the histogram index and 'id' is the item index (for atoms). 'name' indicates the type of parameter, as <a href="https://gsas-ii.readthedocs.io/en/latest/objvarorg.html#parameter-names-in-gsas-ii">defined in developer's docs</a>. Indexes all begin with '0' (zero). The total number of refined parameters is shown at the top of the list. Optionally only those parameters that are refined can be viewed. The "Ref" column shows a "R" for parameters that are refined; a "C" for parameters where values are generated from a constraint. If shown as blank, the parameter value is fixed. Clicking on a row of the table brings up a window where parameter limits may be set. One may set a lower limit value, an upper limit value or both. When a parameter value refines to value outside the limit, the parameter is set to that limit value and the refinement flag for the parameter is subsequently ignored. </p>
+<p><strong>View LS parms</strong> - This shows a dialog box where the status and value of every parameter used in your project can be viewed. The parameter names are of the form <code>p:h:name:id</code> where 'p' is the phase index, 'h' is the histogram index and 'id' is the item index (for atoms). 'name' indicates the type of parameter, as <a href="https://gsas-ii.readthedocs.io/en/latest/objvarorg.html#parameter-names-in-gsas-ii">defined in developer's docs</a>. Indexes all begin with '0' (zero). The total number of refined parameters is shown at the top of the list. Optionally only those parameters that are refined can be viewed. The "Ref" column shows a "R" for parameters that are refined; a "C" for parameters where values are generated from a constraint. If shown as blank, the parameter value is fixed. </p>
+<p>Clicking on a row of the table brings up a window where <strong>parameter limits</strong> may be set. One may set a lower limit value, an upper limit value or both. When a parameter value refines to value outside the limit, the parameter is set to that limit value and the refinement flag for the parameter is subsequently ignored. </p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Note that for atom positions, the variables associated with coordinate values (named as <code>p::Aw:n</code>, where p is the phase number, n is the atom number and w is x, y or z) is not a refinable parameter, but the shift in the value is. The refined parameters are 'p::dAw:n'. The reason this is done is that by treating an atom position as (Ax+dAx,Ay+dAy,Az+dAz) where the “d” values indicate shifts from the starting position. Shifts are refined rather than the x, y, or z values as this this simplifies symmetry constraints. As an example, suppose we have an atom on a symmetry constrained site, <code>x,1/2-x,z</code>. The process needed to enforce this symmetry constraint, so that if x moves positively y has to move negatively by the same amount would be messy. With refinement of shifts, all we need to do is constrain the dAy to be equal to the negative of dAx (<code>0::dAy:n = -1 * 0::dAx:n</code> ).</p>