BornAgain Python user reference

Python user reference of BornAgain Project, an open-source software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering.

Here is a list of classes grouped in several categories to create the sample, describe scattering geometry, run the simulation and perform fitting.

• ISimulation
  List of classes to run simulations
  • Beam
    List of classes to describe the beam, and its footprint in the sample plane
  • Detector
    List of classes to describe detectors
    • Detector masks
• Samples
  List of classes to describe scattering sample
• Materials
  Classes to describe magnetic and non-magnetic materials
• Form factors
  List of form factors available
  • Hard particles
    Three-dimenensional particle shapes
  • Soft particles
    Three-dimenensional particle models with smoothly decaying scattering-length distribution
  • Ripples
    Ripples, for modelling gratings
• Distribution, decay, and interference functions
  
  • Interference functions
  • Fourier-space decay functions
  • Fourier-space distribution functions
  • Parameter distributions
• Tools
  Different tools mainly to deal with intensity data
• Input and output
  Various routines to write intensity data on disk and to import user data.
• Fitting
  Fitting routines

Here is a list of additional classes from internal API.

• ISimulation and instrument internals
  
• Samples internals
  
• Materials internals
  
• Form factors internals
  
• Distribution function internals
• Tools internals
  
• Fitting internals
  

See also

• https://bornagainproject.org, project homepage;
• https://github.com/scgmlz/BornAgain, source repository;

License

GNU General Public License v3 or higher

Copyright Forschungszentrum Jülich GmbH 2015-

Authors

Scientific Computing Group at MLZ Garching.

See file AUTHORS.

Citation

See file CITATION.