Loading...
Searching...
No Matches
Public Member Functions |
Public Attributes |
Protected Member Functions |
Protected Attributes |
List of all members
antares_xpansion.config_loader.XpansionSettingsReader Class Reference
Inheritance diagram for antares_xpansion.config_loader.XpansionSettingsReader:
Public Member Functions | |
| __init__ (self, Path study_path, XpansionConfigConstants xpansion_defaults) | |
| data_dir (self) | |
| antares_output (self) | |
| general_data (self) | |
| candidates_ini_filepath (self) | |
| check_candidates_file_format (self) | |
| check_settings_file_format (self) | |
| weight_file_name (self) | |
| weights_file_path (self) | |
| additional_constraints (self) | |
| capacity_file (self, filename) | |
| json_sensitivity_in_path (self) | |
| get_absolute_optimality_gap (self) | |
| get_relative_optimality_gap (self) | |
| get_relaxed_optimality_gap (self) | |
| get_max_iterations (self) | |
| get_master_formulation (self) | |
| get_separation (self) | |
| get_batch_size (self) | |
| timelimit (self) | |
| log_level (self) | |
| get_master_solution_tolerance (self) | |
| get_cut_coefficient_tolerance (self) | |
Public Attributes | |
| path = study_path | |
| options = self._get_options_from_settings_inifile() | |
Protected Member Functions | |
| _get_path_from_file_in_xpansion_dir (self, filename) | |
| _get_settings_ini_filepath (self) | |
| _verify_settings_ini_file_exists (self) | |
| _get_options_from_settings_inifile (self) | |
| _get_weight_file_path_in_weights_dir (self, filename) | |
| _get_constraints_file_path_in_constraints_dir (self, filename) | |
| _verify_additional_constraints_file (self) | |
Protected Attributes | |
| _config_defaults = xpansion_defaults | |
Detailed Description
Minimal class to read data in a study's setting
Constructor & Destructor Documentation
◆ __init__()
| antares_xpansion.config_loader.XpansionSettingsReader.__init__ | ( | self, | |
| Path | study_path, | ||
| XpansionConfigConstants | xpansion_defaults ) |
Reimplemented in antares_xpansion.config_loader.ConfigLoader.
Member Function Documentation
◆ _get_settings_ini_filepath()
|
protected |
returns path to setting ini file
◆ additional_constraints()
| antares_xpansion.config_loader.XpansionSettingsReader.additional_constraints | ( | self | ) |
returns path to additional constraints file
◆ antares_output()
| antares_xpansion.config_loader.XpansionSettingsReader.antares_output | ( | self | ) |
returns path to antares output data directory
◆ candidates_ini_filepath()
| antares_xpansion.config_loader.XpansionSettingsReader.candidates_ini_filepath | ( | self | ) |
returns path to candidates ini file
◆ capacity_file()
| antares_xpansion.config_loader.XpansionSettingsReader.capacity_file | ( | self, | |
| filename ) |
returns path to input capacity file
◆ data_dir()
| antares_xpansion.config_loader.XpansionSettingsReader.data_dir | ( | self | ) |
returns path to the data directory
◆ general_data()
| antares_xpansion.config_loader.XpansionSettingsReader.general_data | ( | self | ) |
returns path to general data ini file
◆ get_absolute_optimality_gap()
| antares_xpansion.config_loader.XpansionSettingsReader.get_absolute_optimality_gap | ( | self | ) |
returns the absolute optimality gap read from the settings file :return: gap value or 0 if the gap is negative
◆ get_batch_size()
| antares_xpansion.config_loader.XpansionSettingsReader.get_batch_size | ( | self | ) |
returns the batch_size read from the settings file
◆ get_cut_coefficient_tolerance()
| antares_xpansion.config_loader.XpansionSettingsReader.get_cut_coefficient_tolerance | ( | self | ) |
returns the cut_coefficient_tolerance read from the settings file
◆ get_master_formulation()
| antares_xpansion.config_loader.XpansionSettingsReader.get_master_formulation | ( | self | ) |
returns master formulation read from the settings file
◆ get_master_solution_tolerance()
| antares_xpansion.config_loader.XpansionSettingsReader.get_master_solution_tolerance | ( | self | ) |
returns the master_solution_tolerance read from the settings file
◆ get_max_iterations()
| antares_xpansion.config_loader.XpansionSettingsReader.get_max_iterations | ( | self | ) |
prints and returns the maximum iterations read from the settings file :return: max iterations value or -1 if the parameter is set to +Inf or +infini
◆ get_relative_optimality_gap()
| antares_xpansion.config_loader.XpansionSettingsReader.get_relative_optimality_gap | ( | self | ) |
returns the relative optimality gap read from the settings file :return: gap value or 1e-12 if the value is set to a lower value than 1e-12
◆ get_relaxed_optimality_gap()
| antares_xpansion.config_loader.XpansionSettingsReader.get_relaxed_optimality_gap | ( | self | ) |
returns the relaxed optimality gap read from the settings file :return: gap value or 1e-12 if the value is set to a lower value than 1e-12
◆ get_separation()
| antares_xpansion.config_loader.XpansionSettingsReader.get_separation | ( | self | ) |
returns the separation parameter read from the settings file
◆ json_sensitivity_in_path()
| antares_xpansion.config_loader.XpansionSettingsReader.json_sensitivity_in_path | ( | self | ) |
returns path to sensitivity input file
◆ log_level()
| antares_xpansion.config_loader.XpansionSettingsReader.log_level | ( | self | ) |
returns the log_level read from the settings file :return: log_level value
◆ timelimit()
| antares_xpansion.config_loader.XpansionSettingsReader.timelimit | ( | self | ) |
returns the timelimit read from the settings file :return: timelimit value or 0 if the gap is negative
◆ weights_file_path()
| antares_xpansion.config_loader.XpansionSettingsReader.weights_file_path | ( | self | ) |
returns the path to a yearly-weights file :return: path to input yearly-weights file
The documentation for this class was generated from the following file:
- src/python/antares_xpansion/config_loader.py
