Skip to content

Commit f9ee5c0

Browse files
update help files
1 parent 2eaf764 commit f9ee5c0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+157
-132
lines changed

GSASII/help/404.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212

1313

1414
<link rel="icon" href="/images/gsas2.png">
15-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
15+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
1616

1717

1818

1919
<title>GSAS-II Help</title>
2020

2121

2222

23-
<link rel="stylesheet" href="/assets/stylesheets/main.2a3383ac.min.css">
23+
<link rel="stylesheet" href="/assets/stylesheets/main.84d31ad4.min.css">
2424

2525

2626

GSASII/help/anchorIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
applicationwindow.html: Data_tree, Data_frame, Data_Frame, Plots, Console
22
cluster.html: Cluster_Analysis, Cluster-PlotSel
3-
commontreeitems.html: Notebook, Controls, RefinementControls, RefineType, SingleXtlSettings, SequentialSettings, Covariance, Constraints, Constraints-SeqRef, Restraints, RestraintImports, Rigidbodies, Rigid_bodies
3+
commontreeitems.html: Notebook, Controls, RefinementControls, RefineType, SingleXtlSettings, SequentialSettings, Covariance, Constraints, Constraints-SeqRef, Restraints, RestraintImports, RestraintWeights, Rigidbodies, Rigid_bodies
44
datatree.html: DataTreeOverview
55
image.html: IMG, IMG_parent, IMG_Comments, IMG_Image_Controls, IMG_Masks, makemask, IMG_StressStrain, IMG_Stress/Strain
66
index.html: HelpIntro, Index

GSASII/help/applicationwindow.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616

1717

1818
<link rel="icon" href="images/gsas2.png">
19-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
19+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
2020

2121

2222

2323
<title>GUI components - GSAS-II Help</title>
2424

2525

2626

27-
<link rel="stylesheet" href="assets/stylesheets/main.2a3383ac.min.css">
27+
<link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
2828

2929

3030

GSASII/help/assets/stylesheets/main.2a3383ac.min.css

Lines changed: 0 additions & 1 deletion
This file was deleted.

GSASII/help/assets/stylesheets/main.2a3383ac.min.css.map

Lines changed: 0 additions & 1 deletion
This file was deleted.

GSASII/help/assets/stylesheets/main.84d31ad4.min.css

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

GSASII/help/assets/stylesheets/main.84d31ad4.min.css.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

GSASII/help/cluster.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616

1717

1818
<link rel="icon" href="images/gsas2.png">
19-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
19+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
2020

2121

2222

2323
<title>Cluster Analysis - GSAS-II Help</title>
2424

2525

2626

27-
<link rel="stylesheet" href="assets/stylesheets/main.2a3383ac.min.css">
27+
<link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
2828

2929

3030

GSASII/help/commontreeitems.html

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616

1717

1818
<link rel="icon" href="images/gsas2.png">
19-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
19+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
2020

2121

2222

2323
<title>Universal items - GSAS-II Help</title>
2424

2525

2626

27-
<link rel="stylesheet" href="assets/stylesheets/main.2a3383ac.min.css">
27+
<link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
2828

2929

3030

@@ -429,6 +429,15 @@
429429
</span>
430430
</a>
431431

432+
</li>
433+
434+
<li class="md-nav__item">
435+
<a href="#restraint-weights" class="md-nav__link">
436+
<span class="md-ellipsis">
437+
Restraint Weights
438+
</span>
439+
</a>
440+
432441
</li>
433442

434443
</ul>
@@ -1483,6 +1492,15 @@
14831492
</span>
14841493
</a>
14851494

1495+
</li>
1496+
1497+
<li class="md-nav__item">
1498+
<a href="#restraint-weights" class="md-nav__link">
1499+
<span class="md-ellipsis">
1500+
Restraint Weights
1501+
</span>
1502+
</a>
1503+
14861504
</li>
14871505

14881506
</ul>
@@ -1676,7 +1694,7 @@ <h3 id="sequential-refinement-constraints">Sequential Refinement Constraints</h3
16761694
<p><a name="Restraints"></a></p>
16771695
<h2 id="restraints">Restraints</h2>
16781696
<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>
1679-
<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>
1697+
<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. <a href="#RestraintWeights">See below</a> for more discussion on restraint weighting. </p>
16801698
<H3 style="color:blue;font-size:1.1em">What can I do here?</H3>
16811699

16821700
<ul>
@@ -1755,6 +1773,13 @@ <h3 id="importing-restraints">Importing Restraints</h3>
17551773
angle, ignore, C9 C10 C11, OK, ignore, ignore, 116.18, 0.01
17561774
angle, ignore, C11 C12 N15, OK, ignore, ignore, 123.91, 0.02
17571775
</code></pre>
1776+
<p><a name="RestraintWeights"></a></p>
1777+
<h3 id="restraint-weights">Restraint Weights</h3>
1778+
<p>There is no simple recipe for how to weight restraints, in that it varies with the problem, but one should understand is that restraints are used computationally just like any other data point, where the refinement works towards minimizing the sum of
1779+
<span class="arithmatex">\([ w * (obs_i - calc_i ) / \sigma_i ]^2\)</span> where w is usually 1 and <span class="arithmatex">\(obs_i\)</span> might be a powder diffraction intensity but could also be a restraint bond distance and where <span class="arithmatex">\(\sigma_i\)</span> is the uncertainty on <span class="arithmatex">\(obs_i\)</span>, which for restraints is the "esd" value. Since there are usually <span class="arithmatex">\(10^3\)</span> to <span class="arithmatex">\(10^4\)</span> data points and only circa <span class="arithmatex">\(10^1\)</span> restraints, I will usually initially weight the restraints quite highly (100-10,000) since I want to start the fit with a model that closely matches the expected distances and angles. </p>
1780+
<p>As the refinement progresses and I have a good fit, I will then try lowering the restraint weighting. Ideally, I can set the weight on the distances &amp; angles to zero, in which case the restraints will show me a diagnostic of how far the as-fit distances, etc. deviate from my presupposed values, but do not actually change the fit. </p>
1781+
<p>A weight factor of 0 may not produce a good result with complex structures and not very complex diffraction patterns. In those cases, there just is not enough information to define all the structural degrees of freedom uniquely. In that case, lowering the weighting will increase the deviations seen in the restraints with only very trivial improvements in the fit to the powder pattern. One needs to reduce the restraint weight, but only to the point where a chemically reasonable structure is still obtained. Usually, a small value for the weight is needed (around 0.1 to 10) for the final refinements, as very little "force" is needed to keep the structure in agreement with what is expected for the class of materials. </p>
1782+
<p>There is one important case to be aware of, and that is where the restraints are incorrect for the material being studied. If one tries to restrain, for example, a bond to a value that is wrong for the material (for example a carbon-carbon single bond where in fact a double-bond is present) and the data have enough sensitivity to determine this, then the restraints and the data will be in conflict. Lowering the restraint weighting will produce a significant improvement in the fit to the powder data as the bond distance refines away from the target value. If this occurs the restraints need to be corrected to the valid structure. This is different from the case where there is not enough information to define all the structural degrees of freedom, where the fit to the powder data improves only slightly as the restraint is down-weighted. In that latter case, there are very many structures that produce about the same quality of fit, but restraints will prejudice the fit towards models that are more expected based on what is known on the class of materials. </p>
17581783
<p><a name="Rigidbodies"></a>
17591784
<a name="Rigid_bodies"></a></p>
17601785
<h2 id="rigid-bodies">Rigid bodies</h2>

GSASII/help/datatree.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616

1717

1818
<link rel="icon" href="images/gsas2.png">
19-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
19+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
2020

2121

2222

2323
<title>Data tree overview - GSAS-II Help</title>
2424

2525

2626

27-
<link rel="stylesheet" href="assets/stylesheets/main.2a3383ac.min.css">
27+
<link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
2828

2929

3030

0 commit comments

Comments
 (0)