Documentation

This is the documentation of BornAgain-1.19. 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
• How to

Other documents

Complementary information can be found in the following documents:

• Reference Paper: J. Appl. Cryst. 2020
• Form Factor Catalog
• Physics Manual (incomplete)

• Introduction
  • Functionality overview
  • Architectural overview

• Install or build
  • Install
    • Windows
      • Install Python with the Anaconda installer (recommended)
      • Manual Python installation (advanced)
        • VSCode editor
        • PyCharm IDE
      • Python troubleshooting
    • MacOS
      • Advanced tips
    • Linux
  • Build
    • Windows
    • Unix
      • Install third-party software
      • Get the source
      • Build and install BornAgain
      • Run a first simulation

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

• Python scripting
  • Getting started
    • Find BornAgain
    • Run a script
    • Syntax
  • Simulations
    • Reflectometry
      • TOF reflectometry
      • TOF resolution
    • Off-specular
    • GISAS
      • GISAS without reflection
      • GISAS with specular
    • SAS
      • Polarized SANS
    • Depth-probe
  • Instrument model
    • Beam
      • Beam divergence
      • Footprint correction
      • Beam Angular Spread
      • Beam Wavelength Spread
    • Detectors
      • Spherical detector
      • Adding constant background
      • Detector resolution function
      • Rectangular detector
    • Neutron polarization
      • Basic polarized reflectometry
      • Spin-flip reflectivity
      • Without analyzer
      • Non-perfect polarizer + analyzer
      • Spin asymmetry example
  • Sample model
    • Materials
    • Rough interfaces
      • Simulation with a rough sample
      • Different roughness models
      • Rough interfaces
    • Particles
      • Shapes
      • Large qr
      • Custom formfactor
      • Positioning
        • Crossing an interface
        • Positioning example
      • Rotation
        • Rotation example
      • Composition
        • Core and shell
        • Example
      • Distributions
        • Size distribution example
        • Two types of particles with size distribution
      • Magnetic particles
    • 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
        • 2D sum of rotated square lattices
        • Position variance
        • 2D centered square lattice
        • Spheres on Hexagonal Lattice
      • Radial paracrystal
      • 2D paracrystal
      • 3D particle assemblies
        • Mesocrystal
      • Others
        • Size-distribution model: decoupling approximation
        • Size-distribution model: local monodisperse approximation
        • Size-distribution model: size-spacing coupling approximation
    • Layer SLD
      • Cylinders in Averaged Layer
      • Hemispheres in Averaged Layer
  • Fitting
    • Introduction
      • Basic concept
      • Fitting in GISAS
    • Basic examples
      • Minimizer settings
      • Consecutive fitting
    • GISAS 2D fits
    • Advanced examples
      • Fitting with masks
      • Fitting along slices
      • Find background
      • Simultaneous fit of two datasets
    • Importing experimental data
    • Experiment description
    • Bayesian Sampling
    • Extended examples
      • Fitting reflectometry data
      • Custom objective function
      • Experiment at GALAXI
      • Considering uncertainties
      • External minimizer
      • External minimizer: plotting
      • Reflectometry: Real life fitting
      • Spin asymmetry fit example
      • Reflectometry: Fit Pt layer
      • Reflectometry: Fit honeycomb
    • Minimizer settings
  • Plot and export
    • Accessing simulation results
      • Accessing simulation results
      • Plotting with axes in different units
    • Reflectometry
      • Material profile
      • Material profile with particles
    • Find intensity peaks
    • Matplotlib configuration
  • API Documentation

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