Skip to content

Commit 85838c7

Browse files
authored
Changes to add more clarity to documentation (#52)
1 parent 0bda25a commit 85838c7

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

source/advanced/resampling.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Profile Resampling ('microslicing')
55
===================================
66

7-
The Nevot-Croce roughness approximation only strictly holds for cases where the interface roughness is much less than the layer thickness. The usual way
7+
The `Nevot-Croce roughness approximation <https://www.reflectometry.org/learn/3_reflectometry_slab_models/roughness_and_microslicing.html>`_ only strictly holds for cases where the interface roughness is much less than the layer thickness. The usual way
88
of handling cases where this approximation does not hold is to split the interfaces into a large number of layers of zero roughness, so that the roughness problem
99
is circumvented:
1010

source/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@
110110
html_theme = 'pydata_sphinx_theme'
111111
bgcolor = 'white'
112112

113+
# Add switch which numerates figures and allows numeric references to them
114+
numfig = True
115+
113116
# Add any paths that contain custom static files (such as style sheets) here,
114117
# relative to this directory. They are copied after the builtin static files,
115118
# so a file named "default.css" will overwrite the builtin "default.css".

source/tutorial/customModels.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ First, we add our seven parameters (remember that Substrate Roughness is always
144144
145145
.. code-block:: Python
146146
147-
parameters = [['Oxide thick', 5.0, 20.0, 60.0, True],
147+
pGroup = [['Oxide thick', 5.0, 20.0, 60.0, True],
148148
['Oxide Hydration', 0, 0.2, 0.5, True],
149149
['Lipid APM', 45.0, 55.0, 65.0, True],
150150
['Head Hydration', 0, 0.2, 0.5, True],
@@ -541,7 +541,7 @@ In other words, the entire purpose of our custom layer file is to take our param
541541
(e.g. Area per Lipid in our case), and to translate these into a list of :math:`[d, \rho, \sigma]` layers for the whole interface.
542542
You have complete freedom in how you do this, which means that you can make any kind of layer model you can think of using a custom layers file,
543543
including layers that are mixtures of adjoining layers and so on. As long as you can describe your
544-
system as layers with an error function (i.e. Nevot-Croce) roughness you can describe them using custom layer modelling.
544+
system as layers with an error function (i.e. `Nevot-Croce <https://www.reflectometry.org/learn/3_reflectometry_slab_models/roughness_and_microslicing.html>`_) roughness you can describe them using custom layer modelling.
545545

546546
The rest of the custom model is defined similar to the standard layers model shown in :ref:`project`.
547547
So, since we want to analyse three contrasts simultaneously, we need the following:
@@ -741,7 +741,7 @@ In these cases, a second type of custom model can be used, where instead of the
741741
it builds a continuous SLD profile, which is then automatically microsliced by RAT to calculate the reflectivity.
742742
This gives a high degree of flexibility for the type of model that can be generated.
743743

744-
As before, the custom model can be defined in MATLAB, Python, or C++; for the purpose of this tutorial we will just use MATLAB.
744+
As before, the custom model can be defined in MATLAB, Python, or C++; for the purpose of this tutorial we will just use MATLAB and Python.
745745

746746
The inputs into custom XY are the same as for Custom Layers, but the output is now always an [n x 2] array defining a continuous SLD:
747747

source/tutorial/introduction.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,12 @@ In our example, the layers can be either deuterated or hydrogenated, and the bul
8989
.. image:: ../images/tutorial/lipidMonolayer.png
9090
:width: 300
9191
:alt: The lipid monolayer example
92+
9293

93-
We are going to analyze our monolayer data using a standard `slab model <https://www.reflectometry.org/learn/3_reflectometry_slab_models/the_slab_model.html>`_.
94-
In this model, we approximate our experimental model as a series of layers with a known thickness, roughness, SLD and hydration.
95-
The way that this is represented in the RAT model definition is by a list of **Parameter** objects which represent a given quantity (such as a thickness or SLD),
94+
95+
We are going to analyse our monolayer data using a standard `slab model <https://www.reflectometry.org/learn/3_reflectometry_slab_models/the_slab_model.html>`_.
96+
In this model, we approximate our experimental model as a series of layers with a known thickness, roughness, SLD and hydration which modifies SLD.
97+
The way that this is represented in the RAT model definition is by a list of **Parameter** objects which represent a given quantity (such as a thickness or hydration or SLD directly),
9698
and then a list of **Layer** objects which group together these parameters to describe each layer. Layers are then grouped together in a **Contrast** object which
9799
describes the slab model and matches it up to the experimental data to which the model will be compared. In this project we have two contrasts representing
98100
two slab models (one for our deuterated experiment, one for our hydrogenated experiment).

0 commit comments

Comments
 (0)