antares_xpansion.driver.XpansionDriver Class Reference

Classes
class	AntaresArchiveUpdaterExeError
class	SolverXpressRequirementError
class	UnknownStep

Public Member Functions
	__init__ (self, ConfigLoader config_loader)
	launch (self)
	clean_step (self)
	launch_antares_step (self)
	update_study_settings (self, memory_mode=False)
	launch_problem_generation_step (self)
	launch_problem_generation_step_memory (self)
	launch_presolve_step (self)
	launch_benders_step (self)
	launch_sensitivity_step (self)
	resume_study (self)

Public Attributes
	config_loader = config_loader
	logger = step_logger(__name__, __class__.__name__)
	antares_driver = AntaresDriver(self.config_loader.antares_exe())
	problem_generator_driver = ProblemGeneratorDriver(data)
	presolve_driver
	benders_driver
	study_update_driver
	sensitivity_driver
	full_run_driver
str	settings = "settings"
	gen_data_proc

Protected Member Functions
	_update_general_data_ini (self, memory_mode=False)
	_revert_general_data_ini (self)
	_backup_general_data_ini (self)
	_configure_general_data_processor (self)
	_backup_general_data_ini_on_error (self)

Detailed Description

Class to control the execution of the optimization session

Constructor & Destructor Documentation

__init__()

antares_xpansion.driver.XpansionDriver.__init__	(		self,
		ConfigLoader	config_loader )

Initialise driver with a given antaresXpansion configuration,
the system platform and parses the arguments
:param config: configuration to use for the optimization
:type config: XpansionConfig object

Member Function Documentation

launch()

antares_xpansion.driver.XpansionDriver.launch

(

self

)

launch antares xpansion steps

Member Data Documentation

benders_driver

antares_xpansion.driver.XpansionDriver.benders_driver

Initial value:

=  BendersDriver(
            SolversExe(
                self.config_loader.benders_exe(),
                self.config_loader.merge_mps_exe(),
                self.config_loader.outer_loop_exe(),
            ),
            self.config_loader.options_file_name(),
            self.config_loader.mpi_exe(),
        )

full_run_driver

antares_xpansion.driver.XpansionDriver.full_run_driver

Initial value:

=  FullRunDriver(
            self.config_loader.full_run_exe(),
            self.problem_generator_driver,
            self.benders_driver,
            self.presolve_driver
        )

gen_data_proc

antares_xpansion.driver.XpansionDriver.gen_data_proc

Initial value:

=  GeneralDataProcessor(
            settings_dir, self.config_loader.is_accurate()
        )

presolve_driver

antares_xpansion.driver.XpansionDriver.presolve_driver

Initial value:

=  PresolveDriver(
            PresolveData(
                Path(self.config_loader.presolve_exe()),
                self.config_loader.keep_mps()
            ),
            Path(self.config_loader.options_file_name()),
            self.config_loader.run_presolve()
        )

sensitivity_driver

antares_xpansion.driver.XpansionDriver.sensitivity_driver

Initial value:

=  SensitivityDriver(
            self.config_loader.sensitivity_exe()
        )

study_update_driver

antares_xpansion.driver.XpansionDriver.study_update_driver

Initial value:

=  StudyUpdaterDriver(
            self.config_loader.study_update_exe()
        )

---

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

• src/python/antares_xpansion/driver.py