Python API¶

Top-Level¶

`Workspace`	Workspace for managing HS3 model specifications.
`Model`	Probabilistic model with compiled tensor operations.

Modules¶

`distributions`	HS3 Distribution implementations.
`functions`	HS3 Functions implementation.
`domains`	HS3 Domain implementations.
`parameter_points`	HS3 Parameter Point implementations.
`generic_parse`
`exceptions`	Exception classes for pyhs3.

Functions¶

`Functions`	Collection of HS3 functions for parameter computation.
`Function`	Base class for HS3 functions.
`ProductFunction`	Product function that multiplies factors together.
`SumFunction`	Sum function that adds summands together.
`GenericFunction`	Generic function with custom mathematical expression.
`InterpolationFunction`	Piecewise interpolation function implementation.
`ProcessNormalizationFunction`	Process normalization function with systematic variations.

Distributions¶

`Distributions`	Collection of distributions for a probabilistic model.
`Distribution`	Base class for probability distributions in HS3.
`GaussianDist`	Gaussian (normal) probability distribution.
`MixtureDist`	Mixture of probability distributions.
`ProductDist`	Product distribution implementation.
`CrystalBallDist`	Crystal Ball distribution implementation.
`GenericDist`	Generic distribution implementation.
`PoissonDist`	Poisson probability distribution.

Domains¶

`Domains`	Collection of HS3 domains for parameter space definitions.
`Domain`	Base class for HS3 domain specifications.
`ProductDomain`	Product domain specification for multi-dimensional parameter spaces.
`Axis`	Axis specification for parameter domains.

Parameter Points¶

`ParameterPoints`	Collection of HS3 parameter sets for model configuration.
`ParameterSet`	Named collection of parameter specifications (matches HS3Spec structure).
`ParameterPoint`	Individual parameter specification with name and value.

Parsing¶

`parse_expression`	Parse a mathematical expression string into a SymPy expression.
`sympy_to_pytensor`	Converts a SymPy expression into a PyTensor computational graph using lambdify.
`analyze_sympy_expr`	Analyzes a SymPy expression and logs its independent variables, dependent variables, and structure for debugging.

Exceptions¶

`HS3Exception`	Base exception class for all pyhs3-related errors.
`ExpressionParseError`	Exception raised when a mathematical expression cannot be parsed.
`ExpressionEvaluationError`	Exception raised when a parsed expression cannot be evaluated.
`UnknownInterpolationCodeError`	Exception raised when an unknown interpolation code is used.