pleiades.sammy.results.models module

class pleiades.sammy.results.models.ChiSquaredResults(*, chi_squared: float | None = None, dof: int | None = None, reduced_chi_squared: float | None = None)

Bases: BaseModel

Container for chi-squared values and related statistics.

chi_squared: float | None

dof: int | None

reduced_chi_squared: float | None

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pleiades.sammy.results.models.FitResults(*, nuclear_data: nuclearParameters = <factory>, physics_data: PhysicsParameters = <factory>, chi_squared_results: ChiSquaredResults = <factory>)

Bases: BaseModel

A container for combined results from nuclear and experimental data in SAMMY calculations.

nuclear_data: nuclearParameters

physics_data: PhysicsParameters

chi_squared_results: ChiSquaredResults

update_nuclear_data(new_data: nuclearParameters)

Update the nuclear data with new parameters.

update_physics_data(new_data: PhysicsParameters)

Update the physics data with new parameters.

get_physics_data() → PhysicsParameters

Retrieve the current physics data.

get_nuclear_data() → nuclearParameters

Retrieve the current nuclear data.

get_chi_squared_results() → ChiSquaredResults

Retrieve the current chi-squared results.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pleiades.sammy.results.models.RunResults(*, fit_results: list[FitResults] = <factory>, data: SammyData = <factory>)

Bases: BaseModel

RunResults is a container for aggregating multiple fit results from a given SAMMY execution.

fit_results

List of FitResults from multiple fits.

Type:

list[FitResults]

fit_results: list[FitResults]

data: SammyData

add_fit_result(fit_result: FitResults)

Add a FitResults object to the list of fit results.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].