API Reference
This section contains the auto-generated reference detailing the functions and modules available in EasyReflectometry.
Model
Model is a sample, a background and a resolution.
Sample
Sample is built from assemblies.
Project
Project provides a higher-level interface for managing models, experiments, and ORSO import.
Fitting
Fitting helpers and objective functions.
Constraints
Equality constraints and derived parameters tie parameters together and remove the dependent one from the fit. Inequality constraints keep every parameter free and are enforced as penalties on the BUMPS fit problem.
Bayesian Analysis
Posterior analysis of a DREAM sampling run: convergence diagnostics, credible intervals and correlation plots.
Calculators
The backend engines (refl1d, refnx) that turn a model into a reflectivity curve, including the polarized interface.
Parameter Limits
Default min / max windows applied to parameters that have none.
Assemblies
Assemblies are collections of layers that are used to represent a specific physical setup.
Elements
Elements are the building blocks that are required to construct a sample.
Layers
Layers are basic elements and used to represent a single layer of material with a thickness and a roughness.
Materials
Materials are the most basic elements and are used to represent a material with given physical properties.
Data
Collection of helper functions.
Reporting
Summaries of a project and its fit results, and the plotting helpers.