beetroots.simulations package

Subpackages

• beetroots.simulations.astro package
  • Subpackages
    • beetroots.simulations.astro.forward_map package
      • Submodules
      • beetroots.simulations.astro.forward_map.abstract_forward_map module
      • beetroots.simulations.astro.forward_map.abstract_nn module
      • beetroots.simulations.astro.forward_map.abstract_poly_reg module
      • Module contents
    • beetroots.simulations.astro.observation package
      • Submodules
      • beetroots.simulations.astro.observation.abstract_observation module
      • beetroots.simulations.astro.observation.abstract_real_data module
      • beetroots.simulations.astro.observation.abstract_toy_case module
      • Module contents
    • beetroots.simulations.astro.posterior_type package
      • Submodules
      • beetroots.simulations.astro.posterior_type.abstract_direct module
      • beetroots.simulations.astro.posterior_type.abstract_posterior_type module
      • Module contents
    • beetroots.simulations.astro.real_data package
      • Submodules
      • beetroots.simulations.astro.real_data.real_data_nn module
      • Module contents
    • beetroots.simulations.astro.toy_case package
      • Submodules
      • beetroots.simulations.astro.toy_case.toy_case_nn module
      • beetroots.simulations.astro.toy_case.toy_case_polyreg module
      • Module contents
  • Submodules
  • beetroots.simulations.astro.abstract_astro_simulation module
    • AstroSimulation
      • AstroSimulation.D
      • AstroSimulation.DATA_PATH
      • AstroSimulation.D_no_kappa
      • AstroSimulation.D_sampling
      • AstroSimulation.L
      • AstroSimulation.MODELS_PATH
      • AstroSimulation.cloud_name
      • AstroSimulation.list_fixed_values
      • AstroSimulation.list_idx_sampling
      • AstroSimulation.list_lines_fit
      • AstroSimulation.list_names
      • AstroSimulation.list_names_plots
      • AstroSimulation.max_workers
      • AstroSimulation.parse_args()
      • AstroSimulation.pixels_of_interest
      • AstroSimulation.simu_name
  • beetroots.simulations.astro.data_validation module
    • schema
  • Module contents

Submodules

beetroots.simulations.abstract_simulation module

class beetroots.simulations.abstract_simulation.Simulation

Bases: ABC

abstract class for the main class of the inversion. Its instanciations set up, launch and analyze the results of inversions.

classmethod check_input_params_file(params: dict, schema: dict) → None

checks the validity of the params contained in the .yaml input file using the cerberus python package

Parameters:

• params (dict) – content of the .yaml file

• schema (dict) – cerberus validation schema

create_empty_output_folders(simu_name: str, path_yaml_file: str, path_outputs: str) → None

creates the directories that receive the results of the sampling, and saves the .yaml input file there for reproducibility

Parameters:

• simu_name (str) – name of the simulation to be run

• path_yaml_file (str) – path of the folder containing the data and yaml files

• path_outputs (str) – folder where to write outputs

classmethod load_params(path_data_cloud: str, yaml_file: str) → dict

Parameters:

• path_data_cloud (str) – path to the folder containing the .yaml input file. This folder should also contain the data necessary to set up the inversion.

• yaml_file (str) – name of the .yaml input file to be read

Returns:

content of the .yaml input file

Return type:

dict

abstract classmethod parse_args()

setup_plot_text_sizes(small_size: int = 16, medium_size: int = 20, bigger_size: int = 24) → None

defines text sizes on matplotlib plots

Parameters:

• 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

Module contents