How to

Find support resources, project announcements, and citation information.

• Get announcements
• Troubleshoot BornAgain
• Request help or report bugs
• Cite BornAgain

• Introduction
  • Functionality overview

• Install BornAgain
  • Python environment
  • Linux
  • Windows
  • macOS

• Python scripting
  • Run a script
  • Understand the syntax
  • AI-assisted scripting
  • Fitting
  • Upgrading
  • Versioned Python scripts

• Reference
  • Simulation model
    • Simulation classes
      • Specular
      • Scattering
      • Off-specular
        • Yoneda peak
      • Depth probe
    • Common settings
      • Background
      • Options
        • Monte-Carlo
        • # threads
        • Mesocrystal summation
        • Offspec integration
        • Average materials
        • Include specular
      • Progress monitor
  • Instrument model
    • Beam
      • Footprint
      • Beam divergence
    • Scan
    • Detectors
      • SphericalDetector
      • 2d detector resolution
      • Offspec detector
    • Neutron polarization
  • Sample model
    • Materials
      • SLD from chemical formulas
      • Magnetization
    • Multilayer
      • Layer
      • LayerStack
    • Roughness
      • Interface model
      • Transient
      • Cross-correlation
      • Real space
    • Particles
      • Form factor
        • Hard particles
          • Bipyramid4
          • Box
          • CantellatedCube
          • Cone
          • Cylinder
          • Dodecahedron
          • Ellipsoid
          • EllipsoidalCylinder
          • EllipsoidalSegment
          • 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
        • Mixture
        • Compound particle
        • Mesocrystal
    • Structure
      • 2D structures
        • Disorder
          • Uncorrelated mixture
          • Polydispersity
        • Grating
          • 1D lattice
          • 1D paracrystal
          • Triangular ripples in a lattice
        • 2D lattice
          • Square lattice
          • Lattice orientation distribution
          • Finite square lattice
          • Lattice with basis
          • Multi-layer lattice
          • Position variance
        • 2D paracrystal
        • Radial paracrystal
        • Size-distribution models
      • 3D structures
        • Disordered
  • 3D sample view
  • Model modifiers
    • Rotation
    • Correlation profiles
    • Distributions
  • Data import
    • Reflectometry tables
    • 2D ASCII tables
    • Detector images
    • BerSANS / NICOS images
    • HDF5 / NeXus
  • Data types
    • Class Datafield
      • Axis coordinates and transformations
      • Export
    • Material profiles
      • Profiles with rough interfaces
      • SLD profile with a sliced particle layer
  • Plotting
    • Functions
    • Configuration
    • Heat map
    • LaTeX markup
    • Export
  • Fitting
    • Minimizer
    • Residual functions
    • Multiple datasets
    • Fit monitoring

• Examples
  • GISAS
    • Simulation setup and instrument
      • Background
      • Beam divergence
      • Boxes with specular peak
      • Custom background
      • Cylinders
      • Cylinders and specular
      • Lattice with specular
      • Oblique device
      • Resolution
      • Rough and specular
    • Particles, layers, and interfaces
      • Attach above substrate
      • Attach below vacuum
      • Bi-material cylinders
      • Box composition rotate X
      • Box composition rotate Y
      • Box composition rotate Z
      • Box composition rotate Z and Y
      • Box stack composition
      • Compound
      • Compound plus
      • Core shell box rotate Z and Y
      • Core shell nanoparticles
      • Core shell nanoparticles 2
      • Correlated roughness
      • Custom formfactor
      • Custom morphology
      • Cylinders and prisms
      • Cylinders in average layer
      • Cylinders slices
      • Dilute film
      • Film vs density
      • Film vs monolayer
      • Film vs thickness
      • GISAS absorptive SLD layers
      • Half spheres in average top layer
      • Half spheres slices
      • Multi layer with linear growth
      • Multi layer with roughness
      • Multiple layout
      • Particle across interface
      • Polydisperse cylinders
      • Rotated pyramids
      • Sliced composition
      • Sliced layer
      • Soft spheres
      • Soft spheres film
      • Thick absorptive sample with roughness
    • Structures and correlations
      • Centered square lattice 2D
      • Cosine ripple
      • Crystal 1D grating
      • Disordered
      • Finite square lattice
      • Hard disk
      • Hex paracrystal
      • Holes lattice
      • Holes lattice ref
      • Lattice 2D with basis
      • Lattice orientation distribution
      • Mesocone
      • Mesocrystal
      • Mesocrystal evanescent
      • Mesocrystal plus
      • Mesocrystal slices
      • Mesocrystal with basis
      • Mesocrystal with basis slices
      • Paracrystal
      • Paracrystal 1D grating
      • Position variance
      • Radial paracrystal
      • Rectangular grating
      • Rect paracrystal
      • Rotated square lattice 2D
      • Sawtooth ripple
      • Square lattice
      • Square lattice 2D
      • Triangular ripple
      • Triangular ripple PC
      • Two layer lattice
    • Magnetic scattering
      • Magnetic cylinders
      • Magnetic cylinders unpol
      • Magnetic domains
      • Magnetic particle zero field
      • Magnetic rotation unpol
      • Magnetic rotation ZPM
      • Magnetic roughness only
      • Magnetic spheres
      • Magnetic spheres in mag layer
      • Magnetic spheres transmission
      • Magnetic substrate zero field
    • Methods and analysis
      • Approximations
      • Cylinders in BA
      • Cylinders in BA beam from below
      • Cylinders in BA transmission
      • Find peaks
      • Fourier transform
      • Large particles
      • Vs Q
  • SAS
    • Dodecahedra SAS
    • Polarized SANS
  • Specular
    • Basics
      • Alternating layers
      • Basic
      • Solid-liquid interface
      • Homogeneous Ti Ni sample with absorption
      • Reflectivity Q4
    • Instrument and resolution
      • Background
      • Beam full divergence
      • Distributions
      • Footprint correction
      • Gaussian beams
      • Instrument definition comparison
      • Time of flight reflectometry
      • TOF relative resolution
      • TOFR with resolution
      • Vs GenX
    • Roughness and slicing
      • NC roughness in specular
      • Roughness model
      • Specular simulation with roughness
      • Specular with slicing 1
      • Specular with slicing 2
      • Specular with slicing 2Q
      • Specular with slicing 3
    • Magnetic and polarized
      • Basic specular
      • Magnetic field minus Z
      • Magnetic layer
      • Magnetic layer imperfect
      • Magnetic rotation reflectivity
      • Polarized Fe Ni bilayer
      • Polarized Fe Ni bilayer NC
      • Polarized Fe Ni bilayer NCQ
      • Polarized Fe Ni bilayer Q
      • Polarized Fe Ni bilayer spin flip
      • Polarized Fe Ni bilayer spin flip NC
      • Polarized Fe Ni bilayer spin flip NCQ
      • Polarized Fe Ni bilayer spin flip Q
      • Polarized Fe Ni bilayer spin flip tanh
      • Polarized Fe Ni bilayer spin flip tanh Q
      • Polarized Fe Ni bilayer tanh
      • Polarized Fe Ni bilayer tanh Q
      • Polarized Q angle reflectivity
      • Spin asymmetry
      • Stripe domains reflectivity
  • Off-specular
    • Offspec 1
    • Offspec lambda
    • Offspec resolved
    • Offspec resonator
    • Stripe domains
    • Yoneda BA
  • Fitting
    • GISAS
      • Consecutive fitting
      • Expfit GALAXI
      • Fit along slices
      • Fit GISAS
      • Fit with masks
      • Multiple datasets
      • Poisson likelihood
      • SciPy basics
    • Specular
      • Honeycomb fit
      • Likelihood sampling
      • Pt layer fit
      • Specular 1 par
      • Spin asymmetry fit
      • TREFF Ni film
  • Form factors
    • SAS FF
    • Sphere
  • Depth probe
    • Depthprobe
    • Depthprobe 1
    • Opaque 2D
    • Opaque vs alpha
    • Opaque vs depth
    • Resonator
    • Transmission
    • Transmission vs alpha
    • Transmission vs depth
    • Transmitted modulus
  • Sample structure
    • Material from formula
    • Material profile
    • Material profile with particles
    • Rough surface

• How to
  • Get announcements
  • Troubleshoot BornAgain
  • Request help or report bugs
  • Cite BornAgain

• Developers' corner
  • Configure
    • Doxygen
  • Build from source
    • Python dependencies
    • Linux and macOS
      • Get the source
      • Install third-party software
      • Build and install from source
    • Windows
  • Develop
    • Manual checks
    • Debug
    • Webdoc
  • Development wheels
  • Release