Antares Xpansion
Investment simulations for Antares studies
Loading...
Searching...
No Matches
antares_xpansion.resume_study.ResumeStudy Class Reference

Classes

class  KeyWordNotFound
 
class  LastMasterFileNotFound
 
class  MasterFileNotFound
 
class  OptionsFileNotFound
 
class  ResumeOptionsFileNotFound
 
class  StudyOutputPathError
 

Public Member Functions

None __init__ (self, ResumeStudyData resume_study_data)
 
 launch (self)
 
 set_simulation_output_path (self, Path simulation_output_path)
 

Public Attributes

str MPS_SUFFIX = ".mps"
 
 launcher_options_file
 
 benders_exe = resume_study_data.benders_exe
 
 merge_mps_exe = resume_study_data.merge_mps_exe
 
 benders_options_file = resume_study_data.benders_options_file
 
 method
 
 allow_run_as_root
 
 oversubscribe
 
 keep_mps
 
 antares_n_cpu
 
 n_mpi
 

Protected Member Functions

 _load_resume_options (self)
 
 _update_options_file (self)
 

Protected Attributes

 _simulation_output_path = simulation_output_path
 

Member Data Documentation

◆ allow_run_as_root

antares_xpansion.resume_study.ResumeStudy.allow_run_as_root
Initial value:
= resume_options.get(
LauncherOptionsKeys.allow_run_as_root_key(), LauncherOptionsDefaultValues.DEFAULT_ALLOW_RUN_AS_ROOT())

◆ antares_n_cpu

antares_xpansion.resume_study.ResumeStudy.antares_n_cpu
Initial value:
= resume_options.get(
LauncherOptionsKeys.antares_n_cpu_key(), LauncherOptionsDefaultValues.DEFAULT_ANTARES_N_CPU())

◆ keep_mps

antares_xpansion.resume_study.ResumeStudy.keep_mps
Initial value:
= resume_options.get(LauncherOptionsKeys.keep_mps_key(
), LauncherOptionsDefaultValues.DEFAULT_KEEPMPS())

◆ launcher_options_file

antares_xpansion.resume_study.ResumeStudy.launcher_options_file
Initial value:
= self._simulation_output_path / \
resume_study_data.launcher_options_file

◆ method

antares_xpansion.resume_study.ResumeStudy.method
Initial value:
= resume_options.get(
LauncherOptionsKeys.method_key(), LauncherOptionsDefaultValues.DEFAULT_METHOD())

◆ n_mpi

antares_xpansion.resume_study.ResumeStudy.n_mpi
Initial value:
= resume_options.get(
LauncherOptionsKeys.n_mpi_key(), LauncherOptionsDefaultValues.DEFAULT_NP())

◆ oversubscribe

antares_xpansion.resume_study.ResumeStudy.oversubscribe
Initial value:
= resume_options.get(
LauncherOptionsKeys.oversubscribe_key(), LauncherOptionsDefaultValues.DEFAULT_OVERSUBSCRIBE())

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