antares_xpansion.xpansionConfig.XpansionConfig Class Reference

Public Member Functions
	__init__ (self, InputParameters input_parameters, ConfigParameters config_parameters)
	bound_alpha_default_value (self)
	csv_name_default_value (self)
	input_root_default_value (self)
	structure_file_default_value (self)
	master_name_default_value (self)
	problems_format_default_value (self)
	slave_weight_value_default_value (self)
	slave_weight_default_value (self)
	trace_default_value (self)
	outpoutroot_default_value (self)
	aggregation_default_value (self)
	relative_gap_default_value (self)
	absolute_gap_default_value (self)
	relaxed_gap_default_value (self)
	max_iterations_default_value (self)
	initial_master_relaxation_default_value (self)
	separation_default_value (self)
	batch_size_default_value (self)

Public Attributes
	input_parameters = input_parameters
	config_parameters = config_parameters
str	ANTARES = ""
str	MERGE_MPS = ""
str	BENDERS = ""
str	LP_NAMER = ""
str	STUDY_UPDATER = ""
str	SENSITIVITY_EXE = ""
str	FULL_RUN = ""
str	OUTER_LOOP = ""
str	ANTARES_ARCHIVE_UPDATER = ""
str	MPI_LAUNCHER = ""
str	MPI_N = ""
str	MPIEXEC = ""
List[str]	AVAILABLE_SOLVER
	step = self.input_parameters.step
	simulation_name = self.input_parameters.simulation_name
	data_dir = str(Path(self.input_parameters.data_dir).absolute())
	install_dir
	method = self.input_parameters.method
	n_mpi = self.input_parameters.n_mpi
	antares_n_cpu = self.input_parameters.antares_n_cpu
	keep_mps = self.input_parameters.keep_mps
	oversubscribe = self.input_parameters.oversubscribe
	allow_run_as_root = self.input_parameters.allow_run_as_root
	memory = self.input_parameters.memory
str	SETTINGS = "settings"
str	GENERAL_DATA_INI = "generaldata.ini"
str	OUTPUT = "output"
str	USER = "user"
str	EXPANSION = "expansion"
str	SENSITIVITY_DIR = "sensitivity"
str	CAPADIR = "capa"
str	NB_YEARS = "nbyears"
str	SETTINGS_INI = "settings.ini"
str	CANDIDATES_INI = "candidates.ini"
str	UC_TYPE = "uc_type"
str	EXPANSION_ACCURATE = "expansion_accurate"
str	EXPANSION_FAST = "expansion_fast"
str	OPTIONS_JSON = "options.json"
str	LAUNCHER_OPTIONS_JSON = "launcher_options.json"
str	JSON_NAME = "out.json"
str	LAST_ITERATION_JSON_FILE_NAME = "last_iteration.json"
str	JSON_SENSITIVITY_IN = "sensitivity_in.json"
str	JSON_SENSITIVITY_OUT = "sensitivity_out.json"
str	SENSITIVITY_LOG_FILE = "sensitivity_log.txt"
str	LAST_MASTER_MPS = "master_last_iteration"
str	LAST_MASTER_BASIS = "master_last_basis.bss"
str	WEIGHTS = "weights"
str	CONSTRAINTS = "constraints"
str	OUTER_LOOP_FILE = "adequacy_criterion.yml"
str	OUTER_LOOP_DIR = "adequacy_criterion"
str	AREA_FILE = "area.txt"
dict	settings_default
dict	options_default
	default_install_dir = self.config_parameters.default_install_dir

Protected Member Functions
	_get_parameters_from_arguments (self)
	_get_install_dir (self, install_dir)
	_initialize_install_dir_with_default_value (self)
	_initialize_default_values (self)
	_set_constants (self)
	_set_default_settings (self)
	_set_default_options (self)
	_get_config_values (self)

Static Protected Member Functions
	_initialize_install_dir_with_absolute_path (install_dir)

Detailed Description

Class defininf the parameters for an AntaresXpansion session

Member Data Documentation

install_dir

antares_xpansion.xpansionConfig.XpansionConfig.install_dir

Initial value:

=  self._get_install_dir(
            self.input_parameters.install_dir)

options_default

dict antares_xpansion.xpansionConfig.XpansionConfig.options_default

Initial value:

=  {
            OptimisationKeys.max_iterations_key(): self.max_iterations_default_value(),
            OptimisationKeys.absolute_gap_key(): self.absolute_gap_default_value(),
            OptimisationKeys.relative_gap_key(): self.relative_gap_default_value(),
            OptimisationKeys.relaxed_gap_key(): self.relaxed_gap_default_value(),
            OptimisationKeys.aggregation_key(): self.aggregation_default_value(),
            OptimisationKeys.outpoutroot_key(): self.outpoutroot_default_value(),
            OptimisationKeys.trace_key(): self.trace_default_value(),
            OptimisationKeys.slave_weight_key(): self.slave_weight_default_value(),
            OptimisationKeys.slave_weight_value_key(): self.slave_weight_value_default_value(),
            OptimisationKeys.master_name_key(): self.master_name_default_value(),
            OptimisationKeys.problems_format_key(): self.problems_format_default_value(),
            OptimisationKeys.structure_file_key(): self.structure_file_default_value(),
            OptimisationKeys.input_root_key(): self.input_root_default_value(),
            OptimisationKeys.csv_name_key(): self.csv_name_default_value(),
            OptimisationKeys.bound_alpha_key(): self.bound_alpha_default_value(),
            OptimisationKeys.separation_key(): self.separation_default_value(),
            OptimisationKeys.batch_size_key(): self.batch_size_default_value(),
        }

settings_default

dict antares_xpansion.xpansionConfig.XpansionConfig.settings_default

Initial value:

=  {
            "uc_type": "expansion_fast",
            "master": "integer",
            "optimality_gap": "1",
            "relative_gap": "1e-6",
            "max_iteration": "+infini",
            "relaxed_optimality_gap": "1e-5",
            "solver": "Cbc",
            "timelimit": "+infini",
            "additional-constraints": "",
            "yearly-weights": "",
            "log_level": "0",
            "separation_parameter": "0.5",
            "batch_size": "0",
            "problems_format": "SAVED",
        }

---

The documentation for this class was generated from the following file:

• src/python/antares_xpansion/xpansionConfig.py