Classes
class	BendersExecutionError

class	BendersLpPathError

class	BendersOptionsFileError

class	BendersOutputPathError

class	BendersSolverError

class	BendersUnsupportedPlatform

Public Member Functions
None	__init__ (self, SolversExe solvers_exe, options_file, mpiexec=None)

	launch (self, simulation_output_path, method, keep_mps=False, n_mpi=1, oversubscribe=False, allow_run_as_root=False)

	set_simulation_output_path (self, Path simulation_output_path)

	get_simulation_output_path (self)

	get_lp_path (self)

	set_solver (self)

	get_mpi_run_command_root (self)

Public Attributes
bool	oversubscribe = False

bool	allow_run_as_root = False

	benders = solvers_exe.benders

	merge_mps = solvers_exe.merge_mps

	outer_loop = solvers_exe.outer_loop

	mpiexec = mpiexec

str	method = "benders"

int	n_mpi = 1

	logger = step_logger(__name__, __class__.__name__)

	options_file = options_file

str	MPI_N = "-n"

	solver = self.benders

str	MPI_LAUNCHER = self.mpiexec

Protected Member Functions
	_clean_log_files (self)

	_get_solver_cmd (self)

	_initialise_system_specific_mpi_vars (self)

Protected Attributes
	_simulation_output_path = simulation_output_path

Member Function Documentation

◆ _get_solver_cmd()

antares_xpansion.benders_driver.BendersDriver._get_solver_cmd ( self )

protected

returns a list consisting of the path to the required solver and its launching options

antares_xpansion.benders_driver.BendersDriver.launch	(	self,
		simulation_output_path,
		method,
		keep_mps = False,
		n_mpi = 1,
		oversubscribe = False,
		allow_run_as_root = False )

launch the optimization of the antaresXpansion problem using the specified solver

antares_xpansion.benders_driver.BendersDriver.simulation_output_path

static

Initial value:

=  property(
        get_simulation_output_path, set_simulation_output_path
    )

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