antares_xpansion.xpansion_study_reader.XpansionStudyReader Class Reference

Classes
class	BaseException
class	InvalidYearsWeightNumber
class	InvalidYearsWeightValue
class	NoSimulationDirectory
class	NoSolverValue
class	OnlyNullYearsWeightValue
class	SolverNotAvailable

Static Public Member Functions
str	convert_study_solver_to_option_solver (str study_solver)
	check_weights_file (filename_path, int nb_active_years)
	check_solver (str solver_str, List[str] available_solvers)
List[float]	get_years_weight_from_file (Path file_path)

Static Protected Member Functions
	_count_values_and_check_if_all_weights_are_null (filename_path, weights_file)
float	_get_line_value (line, idx, filename_path)

Member Function Documentation

check_solver()

antares_xpansion.xpansion_study_reader.XpansionStudyReader.check_solver ( str  solver_str, List[str]  available_solvers  )

static

check that solver is available in XpansionConfig
if solver_str is empty then solver_str is set to Cbc
:param solver_str: solver obtained from the settings.ini file
:param available_solvers: List of available solvers
:return:

check_weights_file()

antares_xpansion.xpansion_study_reader.XpansionStudyReader.check_weights_file (   filename_path, int  nb_active_years  )

static

    checks that the yearly-weights file exists and has correct format:
        column of non-negative weights
        sum of weights is positive
                        nb_weight equal nb_active_yearse

---

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

• src/python/antares_xpansion/xpansion_study_reader.py