beetroots.simulations.astro.toy_case package

Submodules

beetroots.simulations.astro.toy_case.toy_case_nn module

class beetroots.simulations.astro.toy_case.toy_case_nn.SimulationToyCaseNN(simu_name: str, cloud_name: str, max_workers: int, params_names: Dict[str, str], list_lines_fit: List[str], yaml_file: str, path_data: str, path_outputs: str, path_models: str, forward_model_fixed_params: Dict[str, float | None], pixels_of_interest: Dict[int, str] = {}, small_size: int = 16, medium_size: int = 20, bigger_size: int = 24)[source]

Bases: SimulationNN, SimulationToyCase, SimulationMySampler

Parameters:
  • simu_name (str) – name of the full inversion procedure, used to name the outputs folder

  • cloud_name (str) – name of the observed cloud

  • max_workers (int, optional) – maximum number of workers to run the program

  • params_names (Dict[str, str]) – pairs of names for each parameter, with first the standard name (to be found as title of column in DataFrames) and second a latex name (to be displayed in figures). For instance, for the thermal pressure “P”: r”$P_{th}$)”

  • list_lines_fit (List[str]) – names of the observables used for the inversion

  • max_workers – maximum number of workers that can be used for inversion or results extraction, by default 10

  • small_size (int, optional) – size for basic text, axes titles, xticks and yticks, by default 16

  • medium_size (int, optional) – size of the axis labels, by default 20

  • bigger_size (int, optional) – size of the figure title, by default 24

  • path_outputs (str) – path to the output folder to be created

D

total number of physical parameters involved in the forward map

Type:

int

D_no_kappa

number of physical parameters excluding the scaling parameter \(\kappa\) (used in astrophysical applications). When “kappa” is not in list_names, then D_no_kappa = D

L

number of observables per component \(n\) used for inversion, e.g., per pixel

Type:

int

N
Theta_true_scaled
cloud_name

name of the observed cloud

Type:

str

list_lines_fit

names of the observables used for inversion

Type:

List[str]

list_lines_valid
list_names

names of the physical parameters in files, e.g., as titles of a DataFrame column, e.g., P_th or P for the thermal pressure

Type:

List[str]

list_names_plot
main(params: dict, path_data_cloud: str) None[source]
map_shaper
max_workers

maximum number of workers that can be used for inversion or results extraction

Type:

int

path_data_csv
path_data_csv_in
path_data_csv_out
path_data_csv_out_mcmc
path_data_csv_out_optim_map
path_data_csv_out_optim_mle
path_img
path_output_sim
path_raw
plots_estimator
setup(forward_model_name: str, force_use_cpu: bool, fixed_params: Dict[str, float | None], is_log_scale_params: Dict[str, bool], sigma_a_float: float, sigma_m_float: float, omega_float: float, indicator_margin_scale: float, lower_bounds_lin: ndarray, upper_bounds_lin: ndarray, with_spatial_prior: bool = True, spatial_prior_params: None | SpatialPriorParams = None, list_gaussian_approx_params: List[bool] = [], list_mixing_model_params: List[Dict[str, str]] = [])[source]

beetroots.simulations.astro.toy_case.toy_case_polyreg module

class beetroots.simulations.astro.toy_case.toy_case_polyreg.SimulationToyCasePolyReg(simu_name: str, cloud_name: str, max_workers: int, params_names: Dict[str, str], list_lines_fit: List[str], yaml_file: str, path_data: str, path_outputs: str, path_models: str, forward_model_fixed_params: Dict[str, float | None], pixels_of_interest: Dict[int, str] = {}, small_size: int = 16, medium_size: int = 20, bigger_size: int = 24)[source]

Bases: SimulationPolynomialReg, SimulationToyCase, SimulationMySampler

Parameters:
  • simu_name (str) – name of the full inversion procedure, used to name the outputs folder

  • cloud_name (str) – name of the observed cloud

  • max_workers (int, optional) – maximum number of workers to run the program

  • params_names (Dict[str, str]) – pairs of names for each parameter, with first the standard name (to be found as title of column in DataFrames) and second a latex name (to be displayed in figures). For instance, for the thermal pressure “P”: r”$P_{th}$)”

  • list_lines_fit (List[str]) – names of the observables used for the inversion

  • max_workers – maximum number of workers that can be used for inversion or results extraction, by default 10

  • small_size (int, optional) – size for basic text, axes titles, xticks and yticks, by default 16

  • medium_size (int, optional) – size of the axis labels, by default 20

  • bigger_size (int, optional) – size of the figure title, by default 24

  • path_outputs (str) – path to the output folder to be created

D

total number of physical parameters involved in the forward map

Type:

int

D_no_kappa

number of physical parameters excluding the scaling parameter \(\kappa\) (used in astrophysical applications). When “kappa” is not in list_names, then D_no_kappa = D

L

number of observables per component \(n\) used for inversion, e.g., per pixel

Type:

int

N
Theta_true_scaled
cloud_name

name of the observed cloud

Type:

str

list_lines_fit

names of the observables used for inversion

Type:

List[str]

list_lines_valid
list_names

names of the physical parameters in files, e.g., as titles of a DataFrame column, e.g., P_th or P for the thermal pressure

Type:

List[str]

list_names_plot
main(params: dict, path_data_cloud: str) None[source]
map_shaper
max_workers

maximum number of workers that can be used for inversion or results extraction

Type:

int

path_data_csv
path_data_csv_in
path_data_csv_out
path_data_csv_out_mcmc
path_data_csv_out_optim_map
path_data_csv_out_optim_mle
path_img
path_output_sim
path_raw
plots_estimator
setup(forward_model_name: str, fixed_params: Dict[str, float | None], is_log_scale_params: Dict[str, bool], sigma_a_float: float, sigma_m_float: float, omega_float: float, indicator_margin_scale: float, lower_bounds_lin: ndarray, upper_bounds_lin: ndarray, with_spatial_prior: bool = True, spatial_prior_params: None | SpatialPriorParams = None, list_gaussian_approx_params: List[bool] = [], list_mixing_model_params: List[Dict[str, str]] = [])[source]

Module contents