Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
BornAgain
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mlz
BornAgain
Commits
4732cf3a
Commit
4732cf3a
authored
2 years ago
by
Wuttke, Joachim
Browse files
Options
Downloads
Patches
Plain Diff
webdoc: regularize OffspecSim
parent
85c09ed0
No related branches found
No related tags found
1 merge request
!1476
webdoc: regularize Offspec and GISAS sim
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
hugo/content/py/sim/offspec/index.md
+22
-1
22 additions, 1 deletion
hugo/content/py/sim/offspec/index.md
hugo/content/py/sim/reflectometry/_index.md
+1
-1
1 addition, 1 deletion
hugo/content/py/sim/reflectometry/_index.md
with
23 additions
and
2 deletions
hugo/content/py/sim/offspec/index.md
+
22
−
1
View file @
4732cf3a
...
@@ -3,7 +3,28 @@ title = "Off-specular"
...
@@ -3,7 +3,28 @@ title = "Off-specular"
weight = 20
weight = 20
+++
+++
### Off-Specular scattering
## Off-specular scattering simulation
To set up and run a simulation with off-specular scattering, use
```
python
import
bornagain
as
ba
scan
=
ba
.
AlphaScan
(...)
sample
=
...
detector
=
ba
.
OffspecDetector
(...)
simulation
=
ba
.
OffspecSimulation
(
scan
,
sample
,
detector
)
# ... set options
result
=
simulation
.
simulate
()
```
For the constructor arguments, see sections
[
scan
](
{{%
ref-py "instr/scan" %}}),
[
sample
](
{{%
ref-py "sample" %}}), and
[
OffspecDetector
](
{{%
ref-py "instr/det/offspec" %}}).
For optional settings, see
[
simulation options
](
{{%
ref-py "sim/options" %}}).
For the return type of function
`simulate()`
,
see
[
SimulationResult
](
{{%
ref-py "result/simulation-result" %}}).
#### Example
Off-specular scattering from a monodisperse distribution of long boxes.
Off-specular scattering from a monodisperse distribution of long boxes.
...
...
This diff is collapsed.
Click to expand it.
hugo/content/py/sim/reflectometry/_index.md
+
1
−
1
View file @
4732cf3a
...
@@ -24,7 +24,7 @@ For the return type of function `simulate()`,
...
@@ -24,7 +24,7 @@ For the return type of function `simulate()`,
see
[
SimulationResult
](
{{%
ref-py "result/simulation-result" %}}).
see
[
SimulationResult
](
{{%
ref-py "result/simulation-result" %}}).
### Example
script
### Example
As introductory example, we simulate specular reflectometry
As introductory example, we simulate specular reflectometry
by a sample that consists of 10 Ti/Ni double layers on a Si substrate.
by a sample that consists of 10 Ti/Ni double layers on a Si substrate.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment