Skip to content

Commit b2a1b39

Browse files
committed
restructered files and created a TOC to incorperate tutorials
1 parent 3697370 commit b2a1b39

7 files changed

Lines changed: 29 additions & 34 deletions

File tree

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Therefore, this will be where information for developers will be found, such as
99
---
1010
hidden: True
1111
---
12-
12+
tutorial
1313
build
1414
adrs
1515
ci
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,15 @@ When a project is started two further buttons is visualised, and settings is the
3535
- **A**: Save project.
3636
- **B**: Reset to start.
3737
- **C**: Setting, is further explained in settings.
38+
39+
```{toctree}
40+
---
41+
maxdepth: 1
42+
---
43+
44+
tutorials/model_def.md
45+
tutorials/load_data.md
46+
tutorials/simple_fitting.md
47+
tutorials/settings.md
48+
49+
```

docs/tutorials/index.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
Experimental data must be **.dat**, **.txt**, or **.ort** to be loaded into the EasyReflectometryApp.
44
Data is loaded in the `Experimental` page, by pressing the `Import experimental data`.
55

6-
<img src='./../_images/exp_load.png' width='800px'></img>
6+
<img src='./_images/exp_load.png' width='800px'></img>
77

88
- **A**: Open your file manager to load data in the mentioned format.
99

1010
## Instrumental parameters
1111
When data is loaded, it is possible to change instrumental parameters that affect the data.
1212

13-
<img src='./../_images/exp_data.png' width='800px'></img>
13+
<img src='./_images/exp_data.png' width='800px'></img>
1414

1515
- **A**: Scale the data by the given value.
1616
- **B**: Set the level where data merges into the experimental background.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ When a project is initialised it is then possible to define material and set the
33

44
Let us first look at the general layout of the `Model` page, which is split up into two parts, the main window showing the graphs and the sidebar being the control panel for variables and data.
55

6-
<img src='./../_images/sample_overview.png' width='800px'></img>
6+
<img src='./_images/sample_overview.png' width='800px'></img>
77

88
- **A**: Graph change between the Reflectivity- and Scattering Length Density (SLD) curve.
99
- **B**: Graph control of ledger, visible coordinates on hower, zoom and pan control, and reset.
@@ -14,7 +14,7 @@ Let us first look at the general layout of the `Model` page, which is split up i
1414
To construct a model in the app, first, you add the materials that will compose the layers in `Material Editor`.
1515
The materials are added by the real and imaginary components of the scattering length density (in units of 10<sup>-6</sup>Å<sup>-2</sup>) and given a name for the material.
1616

17-
<img src='./../_images/sample_material.png' width='800px'></img>
17+
<img src='./_images/sample_material.png' width='800px'></img>
1818

1919
- **A**: For adding more material.
2020
- **B**: Duplicating the last clicked material.
@@ -23,7 +23,7 @@ The materials are added by the real and imaginary components of the scattering l
2323
### Model creation and editing
2424
For creating new models, the `Models selector` tab is used, and then for setting the assemblies in the model the `Model editor` is used.
2525

26-
<img src='./../_images/sample_model.png' width='800px'></img>
26+
<img src='./_images/sample_model.png' width='800px'></img>
2727

2828
- **A**: Renaming model.
2929
- **B**: Removing the specific model.
@@ -37,7 +37,7 @@ For creating new models, the `Models selector` tab is used, and then for setting
3737
Then for editing the assemblies in the model, the `Layer editor` is used.
3838
By clicking an assembly, the `Layer editor` is specified and changes can be made to that assembly.
3939

40-
<img src='./../_images/sample_layer.png' width='800px'></img>
40+
<img src='./_images/sample_layer.png' width='800px'></img>
4141

4242
- **A**: Pick the desired assembly to modify.
4343
- **1**: Choose a material from materials in the `Material Editor`.
@@ -46,7 +46,7 @@ By clicking an assembly, the `Layer editor` is specified and changes can be made
4646
## Advanced controls
4747
In the advanced controls, it is possible to apply a specific Q-range of interest and sample constraints on the model.
4848

49-
<img src='./../_images/sample_adv.png' width='800px'></img>
49+
<img src='./_images/sample_adv.png' width='800px'></img>
5050

5151
- **A**: Setting min. Q value of interest.
5252
- **B**: Setting max. Q value of interest.
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Settings
22
The settings can be reached from all tabs by pressing the cogs icon the the top right corner.
33

4-
<img src='./../_images/setting_overview.png' width='800px'></img>
4+
<img src='./_images/setting_overview.png' width='800px'></img>
55

66
In the settings menu, there are five tabs:
7-
#### Prompts
7+
## Prompts
88
Used for enabling/disabling tooltips.
99

10-
#### Updates
10+
## Updates
1111
Allowing the app to check for updates when starting and force-checking for updates.
1212

13-
#### Appearance
13+
## Appearance
1414
Change the theme of the app between: Light, Dark and system mode.
1515

16-
#### Experimental
16+
## Experimental
1717
Setting the overall zoom level of icons and buttons, and changing the language of the app (to be implemented).
1818

19-
#### Develop
19+
## Develop
2020
Is for setting how the app will log errors.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Then a polymer film is attached to the silicon dioxide by some chemical method a
77
This is shown pictorially below, as a slab model.
88

99
<center>
10-
<img src='./../_images/polymer_film.png' width='300px'></img>
10+
<img src='./_images/polymer_film.png' width='800px'></img>
1111
</center>
1212
<center>
1313
A slab model description of the polymer film system.
@@ -20,7 +20,7 @@ The graph window has the same functionality as the previous tabs, so it will not
2020
## Basic controls
2121
The basic controls is for fitting the variables.
2222

23-
<img src='./../_images/anal_bsc.png' width='800px'></img>
23+
<img src='./_images/anal_bsc.png' width='800px'></img>
2424

2525
- **A**: Picking the desired variable to use the slider for fine-tuning it.
2626
- **B**: Able to change the specific variable.
@@ -32,7 +32,7 @@ The basic controls is for fitting the variables.
3232
## Advanced controls
3333
The advanced control is then for changing the calculation engine and setting the minimisation method.
3434

35-
<img src='./../_images/anal_adv.png' width='800px'></img>
35+
<img src='./_images/anal_adv.png' width='800px'></img>
3636

3737
- **A**: Changing the calculation engine between `refnx` and `refl1d`.<br></br>
3838
- **B**: Setting the minimisation method for minimising variables.

0 commit comments

Comments
 (0)