BornAgain
≻
git-main
≻
Documentation
≻
Reference
≻
Instrument model
≻
Examples
≻ Neutron polarization
Neutron polarization
Reflectometry example:
Magnetic layer
Ditto, with imperfect polarizers and detector resolution
Scattering example:
Polarized scattering
Introduction
Functionality overview
Architectural overview
Install or build
Install Python
Python on Linux
Python on Windows
Python on Mac
Python modules
Install BornAgain
Linux
Windows
MacOS
Development snapshot
Build BornAgain
Unix
Install third-party software
Get the source
Build and install BornAgain
Run a first simulation
Windows
Graphical user interface
Quick Start
GUI overview
Fitting in the GUI
Python scripting
Run a script
Understand the syntax
Fitting
Upgrading
Reference
Simulation model
Simulation classes
Specular
Example
Scattering
Examples
GISAS
without DWBA terms
with specular peak
SAS
Polarized SANS
Monte-Carlo
Off-specular
Off-specular
Depth probe
Examples
Thin film
Transmitted modulus
Resonator
Common settings
Background
Options
Monte-Carlo
# threads
Average materials
Include specular
Progress monitor
Instrument model
Beam
Footprint
Beam divergence
Scan
TOF reflectometry
TOF resolution
Beam Angular Spread
Beam Wavelength Spread
Detectors
SphericalDetector
2d detector resolution
Offspec detector
Neutron polarization
Spin asymmetry example
Examples
2D detector resolution
Neutron polarization
Magnetic layer
Ditto, realistic instrument
Polarized scattering
Sample model
Materials
Magnetization
Sample
Layer
Layout
Roughness
API
Interface model
Transient
Cross-correlation
Example: common depth crosscorr
Reflectivity example
Particles
Form factor
Hard particles
Bipyramid4
Box
CantellatedCube
Cone
Cylinder
Dodecahedron
EllipsoidalCylinder
HemiEllipsoid
HorizontalCylinder
Icosahedron
PlatonicOctahedron
PlatonicTetrahedron
Prism3
Prism6
Pyramid2
Pyramid3
Pyramid4
Pyramid6
Sphere
SphericalSegment
Spheroid
SpheroidalSegment
TruncatedCube
Ripples
Bar ripple
Cosine ripple
Sawtooth ripple
Soft particles
FuzzySphere
Gauss
Custom formfactor
Composite particles
Core and shell
Compound particle
Mesocrystal
Examples
Compound particle
Core and shell
Crossing an interface
Mesocrystal
Rotation example
Dense cylinders
Dense hemispheres
Uncorrelated mixture
Polydispersity
Particle assemblies
Grating
1D lattice
Cosine ripples in a lattice
Triangular ripples in a lattice
2D lattice
Hexagonal lattices with basis
2D rotated square lattice
2D square finite lattice
Position variance
2D centered square lattice
Spheres on Hexagonal Lattice
Radial paracrystal
2D paracrystal
Others
Size-distribution model: decoupling approximation
Size-distribution model: local monodisperse approximation
Size-distribution model: size-spacing coupling approximation
Examples
Lattice orientation distribution
Model modifiers
Rotation
Distributions
Data types
Class Datafield
Export
Find intensity peaks
SLD profile
SLD profile with rough interfaces
SLD profile with a sliced particle layer
Plotting
Functions
Configuration
Heat map
LaTeX markup
Export
Plot axes in different units
Fitting
Data import
TIFF
Minimizer settings
Multiple datasets
Examples
Fitting with masks
Custom objective function
Fitting along slices
GISAS 2D fits
Experiment at GALAXI
Find background
Minimizer settings
Bayesian Sampling
Consecutive fitting
Considering uncertainties
External minimizer
External minimizer: plotting
Simultaneous fit of two datasets
Spin asymmetry fit example
Reflectometry: Fit Pt layer
Reflectometry: Fit honeycomb
Literature
Babonneau2010
Babonneau2013
Croset2021
Lazzari2002
Lazzari2006
Pospelov2020
Renaud2009
Sears1992
Wuttke2021
How to
Get announcements
Solve known problems
Request help or report bugs
Cite BornAgain
Developers' corner
Configure
Build
Pyenv
Develop
Manual checks
Debug
Webdoc
Code analyses
Release
Manual GUI test