diff --git a/hugo/content/ex/instr/_index.md b/hugo/content/ex/instr/_index.md index 16126ba35739e56b6fb1fc769bcf98060e56a534..4a6659dd1156990ca6c47c38a50d9342fa604476 100644 --- a/hugo/content/ex/instr/_index.md +++ b/hugo/content/ex/instr/_index.md @@ -1,8 +1,8 @@ +++ title = "Instrument" -weight = 10 +weight = 30 +++ -## Python script examples addressing the instrument model +## Python script examples: instrument model {{% children %}} diff --git a/hugo/content/ex/sim/_index.md b/hugo/content/ex/sim/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..b231d4098c304b559b2dc5846370471ac224b6cb --- /dev/null +++ b/hugo/content/ex/sim/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Simulation" +weight = 10 ++++ + +## Python script examples: simulation types + +{{% children %}} diff --git a/hugo/content/ex/instr/gisas-no-dwba-terms/CylindersInBA_setup.jpg b/hugo/content/ex/sim/gisas-no-dwba-terms/CylindersInBA_setup.jpg similarity index 100% rename from hugo/content/ex/instr/gisas-no-dwba-terms/CylindersInBA_setup.jpg rename to hugo/content/ex/sim/gisas-no-dwba-terms/CylindersInBA_setup.jpg diff --git a/hugo/content/ex/instr/gisas-no-dwba-terms/index.md b/hugo/content/ex/sim/gisas-no-dwba-terms/index.md similarity index 100% rename from hugo/content/ex/instr/gisas-no-dwba-terms/index.md rename to hugo/content/ex/sim/gisas-no-dwba-terms/index.md diff --git a/hugo/content/ex/instr/gisas/CylindersInDWBA_setup.jpg b/hugo/content/ex/sim/gisas/CylindersInDWBA_setup.jpg similarity index 100% rename from hugo/content/ex/instr/gisas/CylindersInDWBA_setup.jpg rename to hugo/content/ex/sim/gisas/CylindersInDWBA_setup.jpg diff --git a/hugo/content/ex/instr/gisas/_index.md b/hugo/content/ex/sim/gisas/_index.md similarity index 100% rename from hugo/content/ex/instr/gisas/_index.md rename to hugo/content/ex/sim/gisas/_index.md diff --git a/hugo/content/ex/instr/sas/_index.md b/hugo/content/ex/sim/sas/_index.md similarity index 100% rename from hugo/content/ex/instr/sas/_index.md rename to hugo/content/ex/sim/sas/_index.md diff --git a/hugo/content/ex/instr/sas/polarized/index.md b/hugo/content/ex/sim/sas/polarized/index.md similarity index 100% rename from hugo/content/ex/instr/sas/polarized/index.md rename to hugo/content/ex/sim/sas/polarized/index.md diff --git a/hugo/content/ex/sim/specular.md b/hugo/content/ex/sim/specular.md new file mode 100644 index 0000000000000000000000000000000000000000..8bd3bf63db917936f75bff82179ddaeea3e09a99 --- /dev/null +++ b/hugo/content/ex/sim/specular.md @@ -0,0 +1,27 @@ ++++ +title = "Specular" +weight = 10 ++++ + +## Basic specular reflectometry example + +As introductory example, we simulate specular reflectometry +by a sample that consists of 10 Ti/Ni double layers on a Si substrate. + +##### Full script + +The same script has been used in the tutorial to explain [usage](/py/start/run.md) +and [syntax](/py/start/syntax.md) of BornAgain Python code. + +{{< figscg src="/img/auto/specular/AlternatingLayers1.png" width="500" class="center">}} + +{{< highlightfile file="Examples/specular/AlternatingLayers1.py">}} + + +##### Shorthand with standard sample + +Since we will use the same sample in several other examples, +we provide the shorthand `std_samples.alternating_layers()` +so that the above script can be shortened as + +{{< highlightfile file="Examples/specular/AlternatingLayers2.py">}} diff --git a/hugo/content/ref/sim/class/specular/index.md b/hugo/content/ref/sim/class/specular/index.md index 18de23f21e68936972a24b8ceb32c17cc088d02f..af3b938870524f580605b29ff3d37bc31cd2bc8c 100644 --- a/hugo/content/ref/sim/class/specular/index.md +++ b/hugo/content/ref/sim/class/specular/index.md @@ -24,30 +24,11 @@ For the return type of function `simulate()`, see [SimulationResult](/ref/sim/simulation-result). -### Example +##### Examples -As introductory example, we simulate specular reflectometry -by a sample that consists of 10 Ti/Ni double layers on a Si substrate. +* [basic specular simulation](/ex/sim/specular) -The same script has been used in preceding pages -to explain [usage](/py/start/run.md) -and [syntax](/py/start/syntax.md) -of BornAgain Python code. - -{{< figscg src="/img/auto/specular/AlternatingLayers1.png" width="500" class="center">}} - -{{< highlightfile file="Examples/specular/AlternatingLayers1.py">}} - - -### Shorthand with standard sample - -Since we will use the same sample in several other examples, -we provide the shorthand `std_samples.alternating_layers()` -so that the above script can be shortened as - -{{< highlightfile file="Examples/specular/AlternatingLayers2.py">}} - -### Further reading +##### Further reading * [specular signal from a rough sample](/ref/sample/roughness/specular/index.md) * [beam footprint correction](/ref/instr/beam/footprint/index.md)