Skip to content
Snippets Groups Projects
Commit f7626444 authored by Mikhail Svechnikov's avatar Mikhail Svechnikov
Browse files

upd hugo docs

parent c2487f84
No related branches found
No related tags found
1 merge request!2730Rename Multilayer to Sample (#20)
Pipeline #163563 passed
......@@ -14,7 +14,7 @@ The differently oriented lattices are incoherently summed
using a loop over the parameter distribution samples.
This is currently supported only under Python scripting, not in the GUI.
Class references: [Layer](/ref/sample/multilayer/layer), [Distributions](/ref/other/distributions).
Class references: [Layer](/ref/sample/sample/layer), [Distributions](/ref/other/distributions).
{{< galleryscg >}}
{{< figscg src="/img/auto/scatter2d/LatticeOrientationDistribution.png" width="450px">}}
......
......@@ -12,7 +12,7 @@ The uncorrelated particles are added to a layout using a loop
over the parameter distribution samples. This is currently supported
only under Python scripting, not in the GUI.
Class references: [Layout](/ref/sample/multilayer/layout),
Class references: [Layout](/ref/sample/sample/layout),
[Distributions](/ref/other/distributions).
{{< galleryscg >}}
......
......@@ -80,7 +80,7 @@ Remember to set the instrument linked to the data (here, "GISAS").
### 4. Performing a fit
#### 4.1 Preparation for fitting
To setup the fitting job, switch back to the Simulation View. In the "Real Data" field, select the name of the real (experimental) dataset which was imported. Now, the data selection box states, as shown below, that an instrument "GISAS" will be used together with the sample "Sample", which represents the multilayer with cylinders that was constructed in section 1, in order to fit the dataset "experimental_data". Click on the "Run Simulation" button to start the simulation.
To setup the fitting job, switch back to the Simulation View. In the "Real Data" field, select the name of the real (experimental) dataset which was imported. Now, the data selection box states, as shown below, that an instrument "GISAS" will be used together with the sample "Sample", which represents the sample with cylinders that was constructed in section 1, in order to fit the dataset "experimental_data". Click on the "Run Simulation" button to start the simulation.
{{< figscg src="/img/draw/tutorial_fitintro04_simulation.png" width="800px" class="center" >}}
......
......@@ -37,7 +37,7 @@ to be created.
{{< figure src="/img/draw/nodes_architecture4.png" class="center">}}
The parent MultiLayer object represents the sample and contains three
The parent Sample object represents the sample and contains three
children: the semi-infinite air layer, the semi-infinite substrate
layer, and the interface between them. The air layer contains the
so-called ParticleLayout object, which holds information about the
......
+++
title = "Multilayer"
title = "Sample"
weight = 35
+++
## Class MultiLayer (toplevel sample model)
## Class Sample (toplevel sample model)
In BornAgain, for the time being, a sample is always represented by an
instance of class `MultiLayer`, even if it is a single-layer SAS sample.
instance of class `Sample`, even if it is a single-layer SAS sample.
##### Create an instance and add layers
......@@ -18,10 +18,9 @@ sample = ba.Sample()
Layers are then added using either of
```python
sample.addLayer(layer)
sample.addLayerWithTopRoughness(layer, roughness)
```
For the arguments, see sections [Layer](/ref/sample/multilayer/layer) and [Roughness](/ref/sample/roughness).
For the arguments, see sections [Layer](/ref/sample/Sample/layer) and [Roughness](/ref/sample/roughness).
The layer added first is the top layer (typically vacuum).
The layer added last is the bottom layer (typically substrate).
......
......@@ -5,14 +5,14 @@ weight = 36
## Class Layer
A [MultiLayer](/ref/sample/multilayer) is composed of one or several instances
A [Sample](/ref/sample/multilayer) is composed of one or several instances
of class `Layer`.
##### Create an instance
Each instance is created using the constructor call
```python
layer_i = ba.Layer(material, thickness=0)
layer_i = ba.Layer(material, thickness=0, roughness=nullptr)
```
Typically, the variable name will contain an index `i`.
By convention, the numbering starts with the top layer, typically `layer_1`.
......
......@@ -5,7 +5,7 @@ weight = 37
## Class ParticleLayout
A [Layer](/ref/sample/multilayer/layer) may contain any number of instances of class `ParticleLayout`.
A [Layer](/ref/sample/Sample/layer) may contain any number of instances of class `ParticleLayout`.
If a layer has more than one layout, then their scattering intensities add incoherently.
##### Create an instance and add particles
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment