BornAgain Python user reference

BornAgain is an open-source software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering.

The following structured list gives access to the documentation of all classes and functions that are needed for steering BornAgain through Python scripts.

Top-level

• Simulation
• Fitting

Instrument model

• Beam and footprint
• Detector
  • Detector masks
• Background

Sample model

• Materials
• Multilayer
• Distribution, decay, and interference functions
  • Interference functions
  • Profiles
• Form factors
  • Hard particles
  • Soft particles
  • Ripples
• Standard samples

Data and parameters

• Input and output
• Intensity tools TODO: Sort differently
• Parameter distributions

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.