Skip to content

Commit f9fc7ef

Browse files
mEngstroemMads_Pufinhenrikjacobsenfys
authored
Tutorial- og Layout update (#210)
* Updated tutorials, restructured index to EasyDiffraction-layout, moved dictionary and calculator into 'tutorials.rst' * Updated based on review of pull request * Removing output from jupyter notebooks --------- Co-authored-by: Mads_Pufin <mads-1803@hotmail.com> Co-authored-by: henrikjacobsenfys <henrik.jacobsen.fys@gmail.com>
1 parent b893b6c commit f9fc7ef

30 files changed

+1183
-898
lines changed

docs/src/calculators.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/src/dictionay.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/src/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,7 @@
77

88
installation
99
usage
10-
sample/sample
11-
calculators
12-
model/model
1310
tutorials/tutorials
14-
dictionary
1511
contributing
1612
authors
1713
api/api

docs/src/tutorials/advancedfitting/multi_contrast.ipynb

Lines changed: 662 additions & 0 deletions
Large diffs are not rendered by default.
File renamed without changes.

docs/src/sample/assemblies_library.rst renamed to docs/src/tutorials/basic/assemblies_library.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
Assemblies
1+
Creating multilayers and surfactant layers
22
==========
33

4-
:py:mod:`easyreflectometry` is designed to be used with a broad range of different assemblies.
5-
These assemblies offer flexibility for the user and enable more powerful analysis by making chemical and pysical constraints available with limited code.
4+
:py:mod:`easyreflectometry` is designed to be used with a broad range of different assemblies.
5+
Assemblies are collective layers behaving as a single object, for example, a multilayer or a surfactant layer.
6+
These assemblies offer flexibility for the user and enable more powerful analysis by making chemical and physical constraints available with limited code.
67
In this page, we will document the assemblies that are available with simple examples of the constructors that exist.
78
Full API documentation is also available for the :py:mod:`easyreflectometry.sample.assemblies` module.
89

910
:py:class:`Multilayer`
1011
----------------------
1112

12-
This assembly should be used for a series of layers that, for whatever reason, should be thought of as a single object.
13+
This assembly should be used for a series of layers that should be thought of as a single object.
1314
For example, in the `simple fitting tutorial`_ this assembly type is used to combine the silicon and silicon dioxide layer that as formed into a single object.
1415
All of the separate layers in these objects will be fitted individually, i.e. there is no constraints present, however, there is some cognative benefit to grouping layers together.
1516

docs/src/sample/layer_library.rst renamed to docs/src/tutorials/basic/layer_library.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Layers
1+
Defining Layers
22
======
33

44
Similar to a range of different `materials`_, there are a few different ways that a layer can be defined in :py:mod:`easyreflectometry`.

docs/src/sample/material_library.rst renamed to docs/src/tutorials/basic/material_library.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Materials
1+
Defining materials
22
=========
33

44
In order to support a wide range of applications (and to build complex `assemblies`_) there are a few different types of material that can be utilised in :py:mod:`easyreflectometry`.
5-
These can include constraints or enabel the user to define the material based on chemical or physical properties.
6-
Full API documentation for the :py:mod:`easyreflectometry.sample.elements.material` mdoule is also available, but here we will give some simple uses for them.
5+
These can include constraints or enable the user to define the material based on chemical or physical properties.
6+
Full API documentation for the :py:mod:`easyreflectometry.sample.elements.material` module is also available, but here we will give some simple uses for them.
77

88
:py:class:`Material`
99
--------------------
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Model
1+
Creating a model
22
=====
33

44
The main component of an experiment in :py:mod:`easyreflectometry` is the :py:class:`Model`.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Sample
1+
Basic
22
======
33

44
The :py:mod:`easyreflectometry` package is focused on making easy to use functionality for specific modelling approaches.

0 commit comments

Comments
 (0)