pleiades.sammy.alphanumerics package

SAMMY Alphanumeric Options Module.

This module implements the various alphanumeric command options for SAMMY. These modules provide Pydantic models for validating and generating SAMMY alphanumeric commands.

class pleiades.sammy.alphanumerics.AngularDistributionOptions(*, use_laboratory_cross_sections: bool = False, use_center_of_mass_cross_sections: bool = True, prepare_legendre_coefficients_in_endf_format: bool = False, omit_finite_size_corrections: bool = False, incident_neutron_attenuation_is_included: bool = False, approximate_scattered_neutron_attenuation: bool = False, angle_average_for_differential_cross_section: bool = False, mutually_exclusive_groups: List[List[str]] = [['use_laboratory_cross_sections', 'use_center_of_mass_cross_sections']])

Bases: BaseModel

model_config = {'validate_default': True}

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

use_laboratory_cross_sections: bool

use_center_of_mass_cross_sections: bool

prepare_legendre_coefficients_in_endf_format: bool

omit_finite_size_corrections: bool

incident_neutron_attenuation_is_included: bool

approximate_scattered_neutron_attenuation: bool

angle_average_for_differential_cross_section: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → AngularDistributionOptions

Validate mutually exclusive fields and ensure exactly one frame option is selected.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.AveragesOptions(*, average_over_energy_ranges: bool = False, group_average_over_energy_ranges: bool = False, energy_average_using_constant_flux: bool = False, maxwellian_averaged_capture_cross_sections: bool = False, calculate_maxwellian_averages_after_reconstruction: bool = False, make_no_corrections_to_theoretical_values: bool = False, add_cross_sections_from_endf_b_file_3: bool = False, print_averaged_sensitivities_for_endf_parameters: bool = False, mutually_exclusive_groups: List[List[str]] = [['average_over_energy_ranges', 'group_average_over_energy_ranges', 'energy_average_using_constant_flux']])

Bases: BaseModel

model_config = {'validate_default': True}

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

average_over_energy_ranges: bool

group_average_over_energy_ranges: bool

energy_average_using_constant_flux: bool

maxwellian_averaged_capture_cross_sections: bool

calculate_maxwellian_averages_after_reconstruction: bool

make_no_corrections_to_theoretical_values: bool

add_cross_sections_from_endf_b_file_3: bool

print_averaged_sensitivities_for_endf_parameters: bool

mutually_exclusive_groups: List[List[str]]

validate_dependencies() → AveragesOptions

Validate logical dependencies between options.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.BayesSolutionOptions(*, solve_bayes_equations: bool = True, do_not_solve_bayes_equations: bool = False, let_sammy_choose_which_inversion_scheme_to_use: bool = True, use_npv_inversion_scheme: bool = False, use_ipq_inversion_scheme: bool = False, use_mpw_inversion_scheme: bool = False, use_least_squares_to_define_prior_parameter_covariance_matrix: bool = False, take_baby_steps_with_least_squares_method: bool = False, remember_original_parameter_values: bool = False, use_remembered_original_parameter_values: bool = False, mutually_exclusive_groups: List[List[str]] = [['solve_bayes_equations', 'do_not_solve_bayes_equations'], ['let_sammy_choose_which_inversion_scheme_to_use', 'use_npv_inversion_scheme', 'use_ipq_inversion_scheme', 'use_mpw_inversion_scheme'], ['use_least_squares_to_define_prior_parameter_covariance_matrix'], ['take_baby_steps_with_least_squares_method'], ['remember_original_parameter_values'], ['use_remembered_original_parameter_values']])

Bases: BaseModel

model_config = {'validate_default': True}

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

solve_bayes_equations: bool

do_not_solve_bayes_equations: bool

let_sammy_choose_which_inversion_scheme_to_use: bool

use_npv_inversion_scheme: bool

use_ipq_inversion_scheme: bool

use_mpw_inversion_scheme: bool

use_least_squares_to_define_prior_parameter_covariance_matrix: bool

take_baby_steps_with_least_squares_method: bool

remember_original_parameter_values: bool

use_remembered_original_parameter_values: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → BayesSolutionOptions

Validate mutually exclusive fields - only one option from each group can be True. If a user explicitly sets an option, it overrides any default in the same group.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.BroadeningOptions(*, broadening_is_wanted: bool = True, broadening_is_not_wanted: bool = False, mutually_exclusive_groups: List[List[str]] = [['broadening_is_wanted', 'broadening_is_not_wanted']])

Bases: BaseModel

model_config = {'validate_default': True}

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

broadening_is_wanted: bool

broadening_is_not_wanted: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → BroadeningOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.CovarianceMatrixOptions(*, implicit_data_covariance: bool = False, user_supplied_implicit_data_covariance: bool = False, pup_covariance_ascii: bool = False, create_pup_file: bool = False, add_constant_term: bool = False, do_not_add_constant_term: bool = True, use_default_constant_term: bool = False, use_ten_percent_uncertainty: bool = False, data_covariance_diagonal: bool = True, data_off_diagonal: bool = False, data_covariance_file: bool = False, free_format_data_covariance: bool = False, mutually_exclusive_groups: List[List[str]] = [['implicit_data_covariance', 'user_supplied_implicit_data_covariance'], ['pup_covariance_ascii'], ['create_pup_file'], ['add_constant_term', 'do_not_add_constant_term', 'use_default_constant_term'], ['use_ten_percent_uncertainty'], ['data_covariance_diagonal', 'data_off_diagonal', 'data_covariance_file', 'free_format_data_covariance']])

Bases: BaseModel

model_config = {'validate_default': True}

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

implicit_data_covariance: bool

user_supplied_implicit_data_covariance: bool

pup_covariance_ascii: bool

create_pup_file: bool

add_constant_term: bool

do_not_add_constant_term: bool

use_default_constant_term: bool

use_ten_percent_uncertainty: bool

data_covariance_diagonal: bool

data_off_diagonal: bool

data_covariance_file: bool

free_format_data_covariance: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → CovarianceMatrixOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.CrossSectionOptions(*, use_polar_coordinates_for_fission_widths: bool = False, numerical_derivatives_for_resonance_parameters: bool = False, do_not_use_s_wave_cutoff: bool = True, use_s_wave_cutoff: bool = False, use_no_cutoffs_for_derivatives: bool = False, use_alternative_coulomb_functions: bool = False, add_direct_capture_component: bool = False, lab_non_coulomb_excitation_energies: bool = True, cm_non_coulomb_excitation_energies: bool = False, lab_coulomb_excitation_energies: bool = True, cm_coulomb_excitation_energies: bool = False, add_eliminated_capture_channel: bool = False, mutually_exclusive_groups: List[List[str]] = [['do_not_use_s_wave_cutoff', 'use_s_wave_cutoff', 'use_no_cutoffs_for_derivatives'], ['lab_non_coulomb_excitation_energies', 'cm_non_coulomb_excitation_energies'], ['lab_coulomb_excitation_energies', 'cm_coulomb_excitation_energies']])

Bases: BaseModel

model_config = {'validate_default': True}

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

use_polar_coordinates_for_fission_widths: bool

numerical_derivatives_for_resonance_parameters: bool

do_not_use_s_wave_cutoff: bool

use_s_wave_cutoff: bool

use_no_cutoffs_for_derivatives: bool

use_alternative_coulomb_functions: bool

add_direct_capture_component: bool

lab_non_coulomb_excitation_energies: bool

cm_non_coulomb_excitation_energies: bool

lab_coulomb_excitation_energies: bool

cm_coulomb_excitation_energies: bool

add_eliminated_capture_channel: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → CrossSectionOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.ENDFOptions(*, input_is_endf_file_2: bool = False, use_energy_range_from_endf_file_2: bool = False, parameter_covariance_matrix_is_in_endf_format: bool = False, data_are_endf_file: bool = False, preserve_gamma_n_not_g_gamma_n_from_endf: bool = False, endf_b_vi_file_2_is_wanted: bool = False, ndf_file_is_in_key_word_format: bool = False, generate_file_3_point_wise_cross_section: bool = False, file_33_lb_1_covariance_is_wanted: bool = False, automatic_ndf_file_creation: bool = False, include_min_and_max_energies_in_endf_file: bool = False, mutually_exclusive_groups: List[List[str]] = [])

Bases: BaseModel

model_config = {'validate_default': True}

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

input_is_endf_file_2: bool

use_energy_range_from_endf_file_2: bool

parameter_covariance_matrix_is_in_endf_format: bool

data_are_endf_file: bool

preserve_gamma_n_not_g_gamma_n_from_endf: bool

endf_b_vi_file_2_is_wanted: bool

ndf_file_is_in_key_word_format: bool

generate_file_3_point_wise_cross_section: bool

file_33_lb_1_covariance_is_wanted: bool

automatic_ndf_file_creation: bool

include_min_and_max_energies_in_endf_file: bool

mutually_exclusive_groups: List[List[str]]

validate_dependencies() → ENDFOptions

Validate logical dependencies between options.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.ExperimentalDataInputOptions(*, data_in_original_multi_style_format: bool = True, data_format_is_one_point_per_line: bool = False, use_csisrs_format_for_data: bool = False, use_twenty_significant_digits: bool = False, data_are_in_standard_odf_format: bool = False, data_are_in_odf_file: bool = False, data_are_endf_b_file: bool = False, use_endf_b_energies_and_data: bool = False, differential_data_are_in_ascii_file: bool = False, do_not_divide_data_into_regions: bool = True, divide_data_into_regions: bool = False, mutually_exclusive_groups: List[List[str]] = [['data_in_original_multi_style_format', 'data_format_is_one_point_per_line', 'use_csisrs_format_for_data', 'use_twenty_significant_digits', 'data_are_in_standard_odf_format', 'data_are_in_odf_file', 'data_are_endf_b_file', 'use_endf_b_energies_and_data'], ['differential_data_are_in_ascii_file'], ['do_not_divide_data_into_regions', 'divide_data_into_regions']])

Bases: BaseModel

model_config = {'validate_default': True}

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

data_in_original_multi_style_format: bool

data_format_is_one_point_per_line: bool

use_csisrs_format_for_data: bool

use_twenty_significant_digits: bool

data_are_in_standard_odf_format: bool

data_are_in_odf_file: bool

data_are_endf_b_file: bool

use_endf_b_energies_and_data: bool

differential_data_are_in_ascii_file: bool

do_not_divide_data_into_regions: bool

divide_data_into_regions: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → ExperimentalDataInputOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.QuantumNumbersOptions(*, new_spin_group_format: bool = True, particle_pair_definitions: bool = False, keyword_particle_pair_definitions: bool = False, quantum_numbers_in_parameter_file: bool = False, put_quantum_numbers_into_parameter_file: bool = False, spin_of_incident_particle_is_plus: bool = False, spin_of_incident_particle_is_minus: bool = False, i4_format_to_read_spin_group_number: bool = False, input_is_endf_b_file: bool = False, use_energy_range_from_endf_b_file_2: bool = False, flag_all_resonance_parameters: bool = False, mutually_exclusive_groups: List[List[str]] = [['new_spin_group_format', 'particle_pair_definitions', 'keyword_particle_pair_definitions'], ['quantum_numbers_in_parameter_file', 'put_quantum_numbers_into_parameter_file'], ['spin_of_incident_particle_is_plus', 'spin_of_incident_particle_is_minus'], ['i4_format_to_read_spin_group_number'], ['input_is_endf_b_file'], ['use_energy_range_from_endf_b_file_2'], ['flag_all_resonance_parameters']])

Bases: BaseModel

Define which type of input is to be used for spin group information and other parameters

model_config = {'validate_default': True}

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

new_spin_group_format: bool

particle_pair_definitions: bool

keyword_particle_pair_definitions: bool

quantum_numbers_in_parameter_file: bool

put_quantum_numbers_into_parameter_file: bool

spin_of_incident_particle_is_plus: bool

spin_of_incident_particle_is_minus: bool

i4_format_to_read_spin_group_number: bool

input_is_endf_b_file: bool

use_energy_range_from_endf_b_file_2: bool

flag_all_resonance_parameters: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → QuantumNumbersOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.LPTOutputOptions(*, do_not_print_any_input_parameters: bool = True, print_all_input_parameters: bool = False, print_varied_input_parameters: bool = False, do_not_print_input_data: bool = True, print_input_data: bool = False, do_not_print_theoretical_values: bool = True, print_theoretical_values: bool = False, do_not_print_partial_derivatives: bool = True, print_partial_derivatives: bool = False, suppress_intermediate_printout: bool = False, do_not_suppress_intermediate_printout: bool = False, do_not_suppress_any_intermediate_printout: bool = True, do_not_use_short_format_for_output: bool = True, use_short_format_for_output: bool = False, do_not_print_reduced_widths: bool = True, print_reduced_widths: bool = False, do_not_print_small_correlation_coefficients: bool = False, do_not_print_debug_info: bool = True, print_debug_information: bool = False, print_capture_area_in_lpt_file: bool = False, chi_squared_is_not_wanted: bool = False, chi_squared_is_wanted: bool = True, do_not_print_weighted_residuals: bool = True, print_weighted_residuals: bool = False, print_bayes_weighted_residuals: bool = False, do_not_print_bayes_weighted_residuals: bool = True, do_not_print_phase_shifts: bool = True, print_phase_shifts_for_input_parameters: bool = False, mutually_exclusive_groups: List[List[str]] = [['do_not_print_any_input_parameters', 'print_all_input_parameters', 'print_varied_input_parameters'], ['do_not_print_input_data', 'print_input_data'], ['do_not_print_theoretical_values', 'print_theoretical_values'], ['do_not_print_partial_derivatives', 'print_partial_derivatives'], ['suppress_intermediate_printout', 'do_not_suppress_intermediate_printout', 'do_not_suppress_any_intermediate_printout'], ['do_not_use_short_format_for_output', 'use_short_format_for_output'], ['do_not_print_reduced_widths', 'print_reduced_widths'], ['do_not_print_debug_info', 'print_debug_information'], ['chi_squared_is_not_wanted', 'chi_squared_is_wanted'], ['do_not_print_weighted_residuals', 'print_weighted_residuals'], ['print_bayes_weighted_residuals', 'do_not_print_bayes_weighted_residuals'], ['do_not_print_phase_shifts', 'print_phase_shifts_for_input_parameters']])

Bases: BaseModel

model_config = {'validate_default': True}

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

do_not_print_any_input_parameters: bool

print_all_input_parameters: bool

print_varied_input_parameters: bool

do_not_print_input_data: bool

print_input_data: bool

do_not_print_theoretical_values: bool

print_theoretical_values: bool

do_not_print_partial_derivatives: bool

print_partial_derivatives: bool

suppress_intermediate_printout: bool

do_not_suppress_intermediate_printout: bool

do_not_suppress_any_intermediate_printout: bool

do_not_use_short_format_for_output: bool

use_short_format_for_output: bool

do_not_print_reduced_widths: bool

print_reduced_widths: bool

do_not_print_small_correlation_coefficients: bool

do_not_print_debug_info: bool

print_debug_information: bool

print_capture_area_in_lpt_file: bool

chi_squared_is_not_wanted: bool

chi_squared_is_wanted: bool

do_not_print_weighted_residuals: bool

print_weighted_residuals: bool

print_bayes_weighted_residuals: bool

do_not_print_bayes_weighted_residuals: bool

do_not_print_phase_shifts: bool

print_phase_shifts_for_input_parameters: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → LPTOutputOptions

get_alphanumeric_commands() → List[str]

class pleiades.sammy.alphanumerics.MultipleScatteringCorrectionsOptions(*, do_not_include_self_shielding: bool = True, use_self_shielding_only: bool = False, use_single_scattering_plus_self_shielding: bool = False, include_double_scattering_corrections: bool = False, infinite_slab: bool = False, finite_slab: bool = True, make_new_file_with_edge_effects: bool = True, file_with_edge_effects_already_exists: bool = False, make_plot_file_of_multiple_scattering_pieces: bool = False, normalize_as_cross_section: bool = False, normalize_as_yield: bool = False, normalize_as_1_minus_e_sigma: bool = False, print_multiple_scattering_corrections: bool = False, prepare_input_for_monte_carlo_simulation: bool = False, y2_values_are_tabulated: bool = False, use_quadratic_interpolation_for_y1: bool = False, use_linear_interpolation_for_y1: bool = False, version_7_for_multiple_scattering: bool = False, do_not_calculate_y0: bool = False, mutually_exclusive_groups: List[List[str]] = [['do_not_include_self_shielding', 'use_self_shielding_only', 'use_single_scattering_plus_self_shielding', 'include_double_scattering_corrections'], ['infinite_slab', 'finite_slab'], ['make_new_file_with_edge_effects', 'file_with_edge_effects_already_exists'], ['make_plot_file_of_multiple_scattering_pieces'], ['normalize_as_cross_section', 'normalize_as_yield', 'normalize_as_1_minus_e_sigma'], ['print_multiple_scattering_corrections', 'prepare_input_for_monte_carlo_simulation', 'y2_values_are_tabulated'], ['use_quadratic_interpolation_for_y1', 'use_linear_interpolation_for_y1'], ['version_7_for_multiple_scattering'], ['do_not_calculate_y0']])

Bases: BaseModel

model_config = {'validate_default': True}

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

do_not_include_self_shielding: bool

use_self_shielding_only: bool

use_single_scattering_plus_self_shielding: bool

include_double_scattering_corrections: bool

infinite_slab: bool

finite_slab: bool

make_new_file_with_edge_effects: bool

file_with_edge_effects_already_exists: bool

make_plot_file_of_multiple_scattering_pieces: bool

normalize_as_cross_section: bool

normalize_as_yield: bool

normalize_as_1_minus_e_sigma: bool

print_multiple_scattering_corrections: bool

prepare_input_for_monte_carlo_simulation: bool

y2_values_are_tabulated: bool

use_quadratic_interpolation_for_y1: bool

use_linear_interpolation_for_y1: bool

version_7_for_multiple_scattering: bool

do_not_calculate_y0: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → MultipleScatteringCorrectionsOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

pleiades.sammy.alphanumerics.PCovarianceMatrixInOptions

alias of CovarianceMatrixOptions

class pleiades.sammy.alphanumerics.CovarianceMatrixOutputOptions(*, write_correlations_into_compact_format: bool = False, put_correlations_into_compact_format: bool = False, write_covariances_into_compact_format: bool = False, put_covariances_into_compact_format: bool = False, put_covariance_matrix_into_endf_file_32: bool = False, mutually_exclusive_groups: List[List[str]] = [['write_correlations_into_compact_format', 'put_correlations_into_compact_format', 'write_covariances_into_compact_format', 'put_covariances_into_compact_format', 'put_covariance_matrix_into_endf_file_32']])

Bases: BaseModel

model_config = {'validate_default': True}

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

write_correlations_into_compact_format: bool

put_correlations_into_compact_format: bool

write_covariances_into_compact_format: bool

put_covariances_into_compact_format: bool

put_covariance_matrix_into_endf_file_32: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → CovarianceMatrixOutputOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.PhysicalConstantsOptions(*, use_endf_values_for_constants: bool = True, use_1995_endf_102_constant_values: bool = False, use_sammy_k1_defaults_for_constants: bool = False, mutually_exclusive_groups: List[List[str]] = [['use_endf_values_for_constants', 'use_1995_endf_102_constant_values', 'use_sammy_k1_defaults_for_constants']])

Bases: BaseModel

model_config = {'validate_default': True}

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

use_endf_values_for_constants: bool

use_1995_endf_102_constant_values: bool

use_sammy_k1_defaults_for_constants: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → PhysicalConstantsOptions

Validate mutually exclusive fields and ensure at least one option is True.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.PlotFileOptions(*, ev_units_on_energy_in_plot_file: bool = False, kev_units_on_energy_in_plot_file: bool = False, mev_units_on_energy_in_plot_file: bool = False, odf_file_is_wanted_zeroth_order: bool = False, odf_file_is_wanted_final_calculation: bool = False, do_not_generate_plot_file_automatically: bool = True, generate_plot_file_automatically: bool = False, do_not_include_theoretical_uncertainties: bool = True, include_theoretical_uncertainties_in_plot_file: bool = False, plot_unbroadened_cross_sections: bool = False, mutually_exclusive_groups: List[List[str]] = [['ev_units_on_energy_in_plot_file', 'kev_units_on_energy_in_plot_file', 'mev_units_on_energy_in_plot_file'], ['do_not_generate_plot_file_automatically', 'generate_plot_file_automatically'], ['do_not_include_theoretical_uncertainties', 'include_theoretical_uncertainties_in_plot_file']])

Bases: BaseModel

model_config = {'validate_default': True}

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

ev_units_on_energy_in_plot_file: bool

kev_units_on_energy_in_plot_file: bool

mev_units_on_energy_in_plot_file: bool

odf_file_is_wanted_zeroth_order: bool

odf_file_is_wanted_final_calculation: bool

do_not_generate_plot_file_automatically: bool

generate_plot_file_automatically: bool

do_not_include_theoretical_uncertainties: bool

include_theoretical_uncertainties_in_plot_file: bool

plot_unbroadened_cross_sections: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → PlotFileOptions

Validate mutually exclusive fields.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.RMatrixOptions(*, reich_moore: bool = True, original_reich_moore: bool = False, multilevel_breit_wigner: bool = False, single_level_breit_wigner: bool = False, reduced_width_amplitudes: bool = False, unresolved_resonance_region: bool = False, mutually_exclusive_groups: List[List[str]] = [['reich_moore', 'original_reich_moore', 'multilevel_breit_wigner', 'single_level_breit_wigner', 'reduced_width_amplitudes', 'unresolved_resonance_region']])

Bases: BaseModel

model_config = {'validate_default': True}

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

reich_moore: bool

original_reich_moore: bool

multilevel_breit_wigner: bool

single_level_breit_wigner: bool

reduced_width_amplitudes: bool

unresolved_resonance_region: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → RMatrixOptions

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.SpecialAnalysisOptions(*, reconstruct_cross_section: bool = False, artificial_energy_grid: bool = False, relevant_parameters_via_uncertainty: bool = False, cross_section_covariance_matrix: bool = False, initial_uncertainty_multiplier: float | None = None, final_uncertainty_multiplier: float | None = None, e_dependent_initial_uncertainty: bool = False, summed_strength_function: bool = False, generate_partial_derivatives_only: bool = False, generate_spin_group_cross_sections: bool = False, reformulate_data_for_idc: bool = False, compare_experiment_to_theory: bool = False, generate_y_and_w_matrices: bool = False, read_y_and_w_matrices: bool = False, stop_command: str | None = None, write_calculated_cross_sections: bool = False, uniform_energy_grid: bool = False, uniform_velocity_grid: bool = False, uniform_time_grid: bool = False, create_publishable_list: bool = False, do_not_test_for_eigenvalues: bool = False, mutually_exclusive_groups: List[List[str]] = [['generate_y_and_w_matrices', 'read_y_and_w_matrices'], ['uniform_energy_grid', 'uniform_velocity_grid', 'uniform_time_grid']])

Bases: BaseModel

model_config = {'validate_default': True}

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

reconstruct_cross_section: bool

artificial_energy_grid: bool

relevant_parameters_via_uncertainty: bool

cross_section_covariance_matrix: bool

initial_uncertainty_multiplier: float | None

final_uncertainty_multiplier: float | None

e_dependent_initial_uncertainty: bool

summed_strength_function: bool

generate_partial_derivatives_only: bool

generate_spin_group_cross_sections: bool

reformulate_data_for_idc: bool

compare_experiment_to_theory: bool

generate_y_and_w_matrices: bool

read_y_and_w_matrices: bool

stop_command: str | None

write_calculated_cross_sections: bool

uniform_energy_grid: bool

uniform_velocity_grid: bool

uniform_time_grid: bool

create_publishable_list: bool

do_not_test_for_eigenvalues: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → SpecialAnalysisOptions

Validate mutually exclusive fields.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

class pleiades.sammy.alphanumerics.URROptions(*, unresolved_resonance_region: bool = False, experimental_data_are_in_separate_files: bool = False, no_annotated_parameter_file_for_urr_input: bool = False, annotated_parameter_file_for_urr: bool = True, output_in_annotated_parameter_file_for_urr: bool = True, use_all_experimental_data_points: bool = True, use_energy_limits_as_given_in_the_input_file: bool = False, calculate_width_fluctuation_factors_more_accurately: bool = False, moldauer_prescription_is_to_be_used: bool = False, mutually_exclusive_groups: List[List[str]] = [['no_annotated_parameter_file_for_urr_input', 'annotated_parameter_file_for_urr'], ['use_all_experimental_data_points', 'use_energy_limits_as_given_in_the_input_file']])

Bases: BaseModel

model_config = {'validate_default': True}

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

unresolved_resonance_region: bool

experimental_data_are_in_separate_files: bool

no_annotated_parameter_file_for_urr_input: bool

annotated_parameter_file_for_urr: bool

output_in_annotated_parameter_file_for_urr: bool

use_all_experimental_data_points: bool

use_energy_limits_as_given_in_the_input_file: bool

calculate_width_fluctuation_factors_more_accurately: bool

moldauer_prescription_is_to_be_used: bool

mutually_exclusive_groups: List[List[str]]

enforce_exclusivity() → URROptions

Validate mutually exclusive fields.

get_alphanumeric_commands() → List[str]

Return the list of alphanumeric commands based on the selected options.

Submodules

• pleiades.sammy.alphanumerics.angular_distribution module
  • AngularDistributionOptions
    • AngularDistributionOptions.model_config
    • AngularDistributionOptions.use_laboratory_cross_sections
    • AngularDistributionOptions.use_center_of_mass_cross_sections
    • AngularDistributionOptions.prepare_legendre_coefficients_in_endf_format
    • AngularDistributionOptions.omit_finite_size_corrections
    • AngularDistributionOptions.incident_neutron_attenuation_is_included
    • AngularDistributionOptions.approximate_scattered_neutron_attenuation
    • AngularDistributionOptions.angle_average_for_differential_cross_section
    • AngularDistributionOptions.mutually_exclusive_groups
    • AngularDistributionOptions.enforce_exclusivity()
    • AngularDistributionOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.averages module
  • AveragesOptions
    • AveragesOptions.model_config
    • AveragesOptions.average_over_energy_ranges
    • AveragesOptions.group_average_over_energy_ranges
    • AveragesOptions.energy_average_using_constant_flux
    • AveragesOptions.maxwellian_averaged_capture_cross_sections
    • AveragesOptions.calculate_maxwellian_averages_after_reconstruction
    • AveragesOptions.make_no_corrections_to_theoretical_values
    • AveragesOptions.add_cross_sections_from_endf_b_file_3
    • AveragesOptions.print_averaged_sensitivities_for_endf_parameters
    • AveragesOptions.mutually_exclusive_groups
    • AveragesOptions.validate_dependencies()
    • AveragesOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.bayes_solution module
  • BayesSolutionOptions
    • BayesSolutionOptions.model_config
    • BayesSolutionOptions.solve_bayes_equations
    • BayesSolutionOptions.do_not_solve_bayes_equations
    • BayesSolutionOptions.let_sammy_choose_which_inversion_scheme_to_use
    • BayesSolutionOptions.use_npv_inversion_scheme
    • BayesSolutionOptions.use_ipq_inversion_scheme
    • BayesSolutionOptions.use_mpw_inversion_scheme
    • BayesSolutionOptions.use_least_squares_to_define_prior_parameter_covariance_matrix
    • BayesSolutionOptions.take_baby_steps_with_least_squares_method
    • BayesSolutionOptions.remember_original_parameter_values
    • BayesSolutionOptions.use_remembered_original_parameter_values
    • BayesSolutionOptions.mutually_exclusive_groups
    • BayesSolutionOptions.enforce_exclusivity()
    • BayesSolutionOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.broadening module
  • BroadeningOptions
    • BroadeningOptions.model_config
    • BroadeningOptions.broadening_is_wanted
    • BroadeningOptions.broadening_is_not_wanted
    • BroadeningOptions.mutually_exclusive_groups
    • BroadeningOptions.enforce_exclusivity()
    • BroadeningOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.covariance_matrix_data module
  • CovarianceMatrixOptions
    • CovarianceMatrixOptions.model_config
    • CovarianceMatrixOptions.implicit_data_covariance
    • CovarianceMatrixOptions.user_supplied_implicit_data_covariance
    • CovarianceMatrixOptions.pup_covariance_ascii
    • CovarianceMatrixOptions.create_pup_file
    • CovarianceMatrixOptions.add_constant_term
    • CovarianceMatrixOptions.do_not_add_constant_term
    • CovarianceMatrixOptions.use_default_constant_term
    • CovarianceMatrixOptions.use_ten_percent_uncertainty
    • CovarianceMatrixOptions.data_covariance_diagonal
    • CovarianceMatrixOptions.data_off_diagonal
    • CovarianceMatrixOptions.data_covariance_file
    • CovarianceMatrixOptions.free_format_data_covariance
    • CovarianceMatrixOptions.mutually_exclusive_groups
    • CovarianceMatrixOptions.enforce_exclusivity()
    • CovarianceMatrixOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.cross_section module
  • CrossSectionOptions
    • CrossSectionOptions.model_config
    • CrossSectionOptions.use_polar_coordinates_for_fission_widths
    • CrossSectionOptions.numerical_derivatives_for_resonance_parameters
    • CrossSectionOptions.do_not_use_s_wave_cutoff
    • CrossSectionOptions.use_s_wave_cutoff
    • CrossSectionOptions.use_no_cutoffs_for_derivatives
    • CrossSectionOptions.use_alternative_coulomb_functions
    • CrossSectionOptions.add_direct_capture_component
    • CrossSectionOptions.lab_non_coulomb_excitation_energies
    • CrossSectionOptions.cm_non_coulomb_excitation_energies
    • CrossSectionOptions.lab_coulomb_excitation_energies
    • CrossSectionOptions.cm_coulomb_excitation_energies
    • CrossSectionOptions.add_eliminated_capture_channel
    • CrossSectionOptions.mutually_exclusive_groups
    • CrossSectionOptions.enforce_exclusivity()
    • CrossSectionOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.endf module
  • ENDFOptions
    • ENDFOptions.model_config
    • ENDFOptions.input_is_endf_file_2
    • ENDFOptions.use_energy_range_from_endf_file_2
    • ENDFOptions.parameter_covariance_matrix_is_in_endf_format
    • ENDFOptions.data_are_endf_file
    • ENDFOptions.preserve_gamma_n_not_g_gamma_n_from_endf
    • ENDFOptions.endf_b_vi_file_2_is_wanted
    • ENDFOptions.ndf_file_is_in_key_word_format
    • ENDFOptions.generate_file_3_point_wise_cross_section
    • ENDFOptions.file_33_lb_1_covariance_is_wanted
    • ENDFOptions.automatic_ndf_file_creation
    • ENDFOptions.include_min_and_max_energies_in_endf_file
    • ENDFOptions.mutually_exclusive_groups
    • ENDFOptions.validate_dependencies()
    • ENDFOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.experimental_data_input module
  • ExperimentalDataInputOptions
    • ExperimentalDataInputOptions.model_config
    • ExperimentalDataInputOptions.data_in_original_multi_style_format
    • ExperimentalDataInputOptions.data_format_is_one_point_per_line
    • ExperimentalDataInputOptions.use_csisrs_format_for_data
    • ExperimentalDataInputOptions.use_twenty_significant_digits
    • ExperimentalDataInputOptions.data_are_in_standard_odf_format
    • ExperimentalDataInputOptions.data_are_in_odf_file
    • ExperimentalDataInputOptions.data_are_endf_b_file
    • ExperimentalDataInputOptions.use_endf_b_energies_and_data
    • ExperimentalDataInputOptions.differential_data_are_in_ascii_file
    • ExperimentalDataInputOptions.do_not_divide_data_into_regions
    • ExperimentalDataInputOptions.divide_data_into_regions
    • ExperimentalDataInputOptions.mutually_exclusive_groups
    • ExperimentalDataInputOptions.enforce_exclusivity()
    • ExperimentalDataInputOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.input_quantum_numbers module
  • QuantumNumbersOptions
    • QuantumNumbersOptions.model_config
    • QuantumNumbersOptions.new_spin_group_format
    • QuantumNumbersOptions.particle_pair_definitions
    • QuantumNumbersOptions.keyword_particle_pair_definitions
    • QuantumNumbersOptions.quantum_numbers_in_parameter_file
    • QuantumNumbersOptions.put_quantum_numbers_into_parameter_file
    • QuantumNumbersOptions.spin_of_incident_particle_is_plus
    • QuantumNumbersOptions.spin_of_incident_particle_is_minus
    • QuantumNumbersOptions.i4_format_to_read_spin_group_number
    • QuantumNumbersOptions.input_is_endf_b_file
    • QuantumNumbersOptions.use_energy_range_from_endf_b_file_2
    • QuantumNumbersOptions.flag_all_resonance_parameters
    • QuantumNumbersOptions.mutually_exclusive_groups
    • QuantumNumbersOptions.enforce_exclusivity()
    • QuantumNumbersOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.lpt module
  • LPTOutputOptions
    • LPTOutputOptions.model_config
    • LPTOutputOptions.do_not_print_any_input_parameters
    • LPTOutputOptions.print_all_input_parameters
    • LPTOutputOptions.print_varied_input_parameters
    • LPTOutputOptions.do_not_print_input_data
    • LPTOutputOptions.print_input_data
    • LPTOutputOptions.do_not_print_theoretical_values
    • LPTOutputOptions.print_theoretical_values
    • LPTOutputOptions.do_not_print_partial_derivatives
    • LPTOutputOptions.print_partial_derivatives
    • LPTOutputOptions.suppress_intermediate_printout
    • LPTOutputOptions.do_not_suppress_intermediate_printout
    • LPTOutputOptions.do_not_suppress_any_intermediate_printout
    • LPTOutputOptions.do_not_use_short_format_for_output
    • LPTOutputOptions.use_short_format_for_output
    • LPTOutputOptions.do_not_print_reduced_widths
    • LPTOutputOptions.print_reduced_widths
    • LPTOutputOptions.do_not_print_small_correlation_coefficients
    • LPTOutputOptions.do_not_print_debug_info
    • LPTOutputOptions.print_debug_information
    • LPTOutputOptions.print_capture_area_in_lpt_file
    • LPTOutputOptions.chi_squared_is_not_wanted
    • LPTOutputOptions.chi_squared_is_wanted
    • LPTOutputOptions.do_not_print_weighted_residuals
    • LPTOutputOptions.print_weighted_residuals
    • LPTOutputOptions.print_bayes_weighted_residuals
    • LPTOutputOptions.do_not_print_bayes_weighted_residuals
    • LPTOutputOptions.do_not_print_phase_shifts
    • LPTOutputOptions.print_phase_shifts_for_input_parameters
    • LPTOutputOptions.mutually_exclusive_groups
    • LPTOutputOptions.enforce_exclusivity()
    • LPTOutputOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.multiple_scattering_corrections module
  • MultipleScatteringCorrectionsOptions
    • MultipleScatteringCorrectionsOptions.model_config
    • MultipleScatteringCorrectionsOptions.do_not_include_self_shielding
    • MultipleScatteringCorrectionsOptions.use_self_shielding_only
    • MultipleScatteringCorrectionsOptions.use_single_scattering_plus_self_shielding
    • MultipleScatteringCorrectionsOptions.include_double_scattering_corrections
    • MultipleScatteringCorrectionsOptions.infinite_slab
    • MultipleScatteringCorrectionsOptions.finite_slab
    • MultipleScatteringCorrectionsOptions.make_new_file_with_edge_effects
    • MultipleScatteringCorrectionsOptions.file_with_edge_effects_already_exists
    • MultipleScatteringCorrectionsOptions.make_plot_file_of_multiple_scattering_pieces
    • MultipleScatteringCorrectionsOptions.normalize_as_cross_section
    • MultipleScatteringCorrectionsOptions.normalize_as_yield
    • MultipleScatteringCorrectionsOptions.normalize_as_1_minus_e_sigma
    • MultipleScatteringCorrectionsOptions.print_multiple_scattering_corrections
    • MultipleScatteringCorrectionsOptions.prepare_input_for_monte_carlo_simulation
    • MultipleScatteringCorrectionsOptions.y2_values_are_tabulated
    • MultipleScatteringCorrectionsOptions.use_quadratic_interpolation_for_y1
    • MultipleScatteringCorrectionsOptions.use_linear_interpolation_for_y1
    • MultipleScatteringCorrectionsOptions.version_7_for_multiple_scattering
    • MultipleScatteringCorrectionsOptions.do_not_calculate_y0
    • MultipleScatteringCorrectionsOptions.mutually_exclusive_groups
    • MultipleScatteringCorrectionsOptions.enforce_exclusivity()
    • MultipleScatteringCorrectionsOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.p_covariance_matrix_in module
  • CovarianceMatrixOptions
    • CovarianceMatrixOptions.model_config
    • CovarianceMatrixOptions.ignore_input_binary_covariance_file
    • CovarianceMatrixOptions.energy_uncertainties_at_end_of_line_in_par_file
    • CovarianceMatrixOptions.retroactive_old_parameter_file_new_covariance
    • CovarianceMatrixOptions.p_covariance_matrix_is_correct_u_is_not
    • CovarianceMatrixOptions.modify_p_covariance_matrix_before_using
    • CovarianceMatrixOptions.initial_diagonal_u_covariance
    • CovarianceMatrixOptions.initial_diagonal_p_covariance
    • CovarianceMatrixOptions.permit_non_positive_definite_parameter_covariance_matrices
    • CovarianceMatrixOptions.permit_zero_uncertainties_on_parameters
    • CovarianceMatrixOptions.read_compact_covariances_for_parameter_priors
    • CovarianceMatrixOptions.read_compact_correlations_for_parameter_priors
    • CovarianceMatrixOptions.compact_correlations_are_to_be_read_and_used
    • CovarianceMatrixOptions.compact_covariances_are_to_be_read_and_used
    • CovarianceMatrixOptions.parameter_covariance_matrix_is_in_endf_format
    • CovarianceMatrixOptions.endf_covariance_matrix_is_to_be_read_and_used
    • CovarianceMatrixOptions.use_least_squares_to_define_prior_parameter_covariance_matrix
    • CovarianceMatrixOptions.mutually_exclusive_groups
    • CovarianceMatrixOptions.enforce_exclusivity()
    • CovarianceMatrixOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.p_covariance_matrix_out module
  • CovarianceMatrixOutputOptions
    • CovarianceMatrixOutputOptions.model_config
    • CovarianceMatrixOutputOptions.write_correlations_into_compact_format
    • CovarianceMatrixOutputOptions.put_correlations_into_compact_format
    • CovarianceMatrixOutputOptions.write_covariances_into_compact_format
    • CovarianceMatrixOutputOptions.put_covariances_into_compact_format
    • CovarianceMatrixOutputOptions.put_covariance_matrix_into_endf_file_32
    • CovarianceMatrixOutputOptions.mutually_exclusive_groups
    • CovarianceMatrixOutputOptions.enforce_exclusivity()
    • CovarianceMatrixOutputOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.physical_constants module
  • PhysicalConstantsOptions
    • PhysicalConstantsOptions.model_config
    • PhysicalConstantsOptions.use_endf_values_for_constants
    • PhysicalConstantsOptions.use_1995_endf_102_constant_values
    • PhysicalConstantsOptions.use_sammy_k1_defaults_for_constants
    • PhysicalConstantsOptions.mutually_exclusive_groups
    • PhysicalConstantsOptions.enforce_exclusivity()
    • PhysicalConstantsOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.plot_file module
  • PlotFileOptions
    • PlotFileOptions.model_config
    • PlotFileOptions.ev_units_on_energy_in_plot_file
    • PlotFileOptions.kev_units_on_energy_in_plot_file
    • PlotFileOptions.mev_units_on_energy_in_plot_file
    • PlotFileOptions.odf_file_is_wanted_zeroth_order
    • PlotFileOptions.odf_file_is_wanted_final_calculation
    • PlotFileOptions.do_not_generate_plot_file_automatically
    • PlotFileOptions.generate_plot_file_automatically
    • PlotFileOptions.do_not_include_theoretical_uncertainties
    • PlotFileOptions.include_theoretical_uncertainties_in_plot_file
    • PlotFileOptions.plot_unbroadened_cross_sections
    • PlotFileOptions.mutually_exclusive_groups
    • PlotFileOptions.enforce_exclusivity()
    • PlotFileOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.r_matrix module
  • RMatrixOptions
    • RMatrixOptions.model_config
    • RMatrixOptions.reich_moore
    • RMatrixOptions.original_reich_moore
    • RMatrixOptions.multilevel_breit_wigner
    • RMatrixOptions.single_level_breit_wigner
    • RMatrixOptions.reduced_width_amplitudes
    • RMatrixOptions.unresolved_resonance_region
    • RMatrixOptions.mutually_exclusive_groups
    • RMatrixOptions.enforce_exclusivity()
    • RMatrixOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.special_analysis module
  • SpecialAnalysisOptions
    • SpecialAnalysisOptions.model_config
    • SpecialAnalysisOptions.reconstruct_cross_section
    • SpecialAnalysisOptions.artificial_energy_grid
    • SpecialAnalysisOptions.relevant_parameters_via_uncertainty
    • SpecialAnalysisOptions.cross_section_covariance_matrix
    • SpecialAnalysisOptions.initial_uncertainty_multiplier
    • SpecialAnalysisOptions.final_uncertainty_multiplier
    • SpecialAnalysisOptions.e_dependent_initial_uncertainty
    • SpecialAnalysisOptions.summed_strength_function
    • SpecialAnalysisOptions.generate_partial_derivatives_only
    • SpecialAnalysisOptions.generate_spin_group_cross_sections
    • SpecialAnalysisOptions.reformulate_data_for_idc
    • SpecialAnalysisOptions.compare_experiment_to_theory
    • SpecialAnalysisOptions.generate_y_and_w_matrices
    • SpecialAnalysisOptions.read_y_and_w_matrices
    • SpecialAnalysisOptions.stop_command
    • SpecialAnalysisOptions.write_calculated_cross_sections
    • SpecialAnalysisOptions.uniform_energy_grid
    • SpecialAnalysisOptions.uniform_velocity_grid
    • SpecialAnalysisOptions.uniform_time_grid
    • SpecialAnalysisOptions.create_publishable_list
    • SpecialAnalysisOptions.do_not_test_for_eigenvalues
    • SpecialAnalysisOptions.mutually_exclusive_groups
    • SpecialAnalysisOptions.enforce_exclusivity()
    • SpecialAnalysisOptions.get_alphanumeric_commands()
• pleiades.sammy.alphanumerics.urr module
  • URROptions
    • URROptions.model_config
    • URROptions.unresolved_resonance_region
    • URROptions.experimental_data_are_in_separate_files
    • URROptions.no_annotated_parameter_file_for_urr_input
    • URROptions.annotated_parameter_file_for_urr
    • URROptions.output_in_annotated_parameter_file_for_urr
    • URROptions.use_all_experimental_data_points
    • URROptions.use_energy_limits_as_given_in_the_input_file
    • URROptions.calculate_width_fluctuation_factors_more_accurately
    • URROptions.moldauer_prescription_is_to_be_used
    • URROptions.mutually_exclusive_groups
    • URROptions.enforce_exclusivity()
    • URROptions.get_alphanumeric_commands()