Documentation

This is the documentation of BornAgain version 21. For other releases, see here.

Software and documentation are work in progress. Some features of the software are not yet documented. Contact us for any questions.

Contents

• Introduction
• Install or build
• Graphical user interface
• Python scripting
• Script examples
• Reference
• Literature
• How to

Other documents

Complementary information can be found in the

• Reference Paper: J. Appl. Cryst. 2020
• Physics Reference

Older course materials are at

• https://github.com/scgmlz/BornAgain-tutorial

• 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
  • Build BornAgain
    • Unix
      • Install third-party software
      • Get the source
      • Build and install BornAgain
      • Run a first simulation
    • Windows
  • Developer build

• Graphical user interface
  • Quick Start
  • GUI overview
  • Fitting in the GUI

• Python scripting
  • Run a script
  • Understand the syntax
  • Fitting

• Script examples
  • Simulation
    • Specular
    • without DWBA terms
    • GISAS
    • Off-specular
    • SAS
      • Polarized SANS
    • Depth probe
      • Thin film
      • Transmitted modulus
      • Resonator
  • Instrument
    • Neutron polarization
      • Magnetic layer
      • Ditto, realistic instrument
      • Polarized scattering
  • Sample
    • Roughness
      • Reflectivity, default model
      • Different roughness models
      • Scattering
    • Particles
      • Compound particle
      • Core and shell
      • Crossing an interface
      • Rotation example
      • Dense cylinders
      • Dense hemispheres
      • Polydispersity
    • Assemblies
      • Lattice orientation distribution
  • Fitting
    • 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
  • Plot and export
    • Accessing simulation results
      • Accessing simulation results
      • Plotting with axes in different units
    • SLD profile
      • SLD profile with rough interfaces
      • SLD profile with a sliced particle layer
    • Find intensity peaks

• Reference
  • Simulation model
    • Simulation classes
      • Specular
      • Scattering
      • Off-specular
      • Depth probe
    • Common settings
      • Background
      • Options
        • Monte-Carlo
        • # threads
        • Average materials
        • Include specular
      • Progress monitor
    • Class SimulationResult
  • Instrument model
    • Beam
      • Footprint
      • Beam divergence
      • Beam Angular Spread
      • Beam Wavelength Spread
    • Scan
      • TOF reflectometry
      • TOF resolution
    • Detectors
      • Spherical detector
      • Detector resolution function
      • Rectangular detector
      • Offspec detector
    • Neutron polarization
      • Spin asymmetry example
  • Sample model
    • Materials
      • Magnetization
    • Multilayer
      • Layer
      • Layout
    • Rough interfaces
    • Particles
      • Form factor
        • Hard particles
          • Bipyramid4
          • Box
          • CantellatedCube
          • Cone
          • Cylinder
          • Dodecahedron
          • EllipsoidalCylinder
          • HemiEllipsoid
          • HorizontalCylinder
          • Icosahedron
          • PlatonicOctahedron
          • PlatonicTetrahedron
          • Prism3
          • Prism6
          • Pyramid2
          • Pyramid3
          • Pyramid4
          • Pyramid6
          • Sphere
          • Spheroid
          • TruncatedCube
          • TruncatedSphere
          • TruncatedSpheroid
        • Ripples
        • Soft particles
          • FuzzySphere
          • Gauss
        • Custom formfactor
      • Composite particles
        • Core and shell
        • Compound particle
    • Particle assemblies
      • Uncorrelated mixture
      • Grating
        • 1D lattice
        • Cosine ripples in a lattice
        • Triangular ripples in a lattice
        • Rectangular grating
      • 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
  • Common modifiers
    • Rotation
    • Distributions
  • Fitting
    • Data import
      • TIFF
    • Minimizer settings
  • Plot and export
    • Matplotlib configuration

• Literature
  • Babonneau2010
  • Babonneau2013
  • Croset2021
  • Lazzari2002
  • Lazzari2006
  • Pospelov2020
  • Renaud2009
  • Sears1992
  • Wuttke2021

• How to
  • Get announcements
  • Solve known problems
  • Request help or report bugs
  • Contribute to this documentation
  • Cite BornAgain