Installing BornAgain

Here are the platform specific instructions to install BornAgain as a binary.

• Windows
• MacOS
• Linux

• Introduction
  • Functionality overview
  • Architectural overview

• Install or build
  • Install
    • Windows
      • Python troubleshooting
    • MacOS
    • Linux
  • Build
    • Windows
    • Unix
      • Install third-party software
      • Get the source
      • Build and install BornAgain
      • Run a first simulation

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

• Python scripting
  • Getting started
    • Run a script
    • Understand the syntax
  • 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
    • SLD profile
      • SLD profile with rough interfaces
      • SLD profile with a sliced particle layer
    • Find intensity peaks
    • Matplotlib configuration

• Script examples
  • Simulation
    • Specular
    • without DWBA terms
    • GISAS
    • Off-specular
    • SAS
      • Polarized SANS
  • Instrument
    • Polarized scattering
  • Sample
    • Compound particle
    • Core and shell
    • Crossing an interface
    • Rotation example
    • Dense cylinders
    • Dense hemispheres
    • Polydispersity
    • Lattice orientation distribution

• Reference
  • Simulation model
    • Simulation classes
      • Specular
      • Scattering
      • Off-specular
      • Depth probe
    • Common settings
      • Constant 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
      • Basic polarized reflectometry
      • Spin-flip reflectivity
      • Without analyzer
      • Non-perfect polarizer + analyzer
      • Spin asymmetry example
  • Sample model
    • Materials
      • Magnetization
    • Multilayer
      • Layer
      • Layout
    • Rough interfaces
      • Simulation with a rough sample
      • Different roughness models
      • 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

• 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