API for antaresEditObject
Edit an 'Antares' Simulation

Global functions
.AddClusterToDST Source code
.addBindingConstraintToDSR Source code
.addBindingConstraintToPSP Source code
.addDSRArea Source code
.addLinksBetweenDSRAndAreas Source code
.addLinksBetweenPspAndAreas Source code
.addOneOfTheVirtualArea Source code
.addRowBalance Source code
.aggregateMc Source code
.api_command_execute_edit_area Man page Source code
.checkDataEditDSR Source code
.checkDataForAddDSR Source code
.checkDataForAddPSP Source code
.check_area_in_binding_constraint Source code
.check_bulk_object_dim Source code
.check_capacity Source code
.check_format_offset Source code
.cleanUpOutputSingle Source code
.compute_matrix_dimension_constraint Source code
.createBC_api Source code
.createCluster Source code
.createClusterBulk Source code
.createColumns Source code
.dailyToWeekly Man page Source code
.delete_by_group Source code
.delete_by_name Source code
.editBC_api Source code
.editCluster Source code
.format_ini_rhs Man page Source code
.format_playlist_weights Man page Source code
.formatedIni Source code
.formatedIniList Source code
.generate_params_editArea Source code
.getCoefDsr Source code
.getLinkName Source code
.getNameDsr Source code
.getTheDsrName Source code
.getTheLastVirualName Source code
.getjobs Source code
.give_week_day Source code
.hourlyToOther Man page Source code
.initializeLinksArea Man page Source code
.initializeRenewablesArea Man page Source code
.initializeThermalArea Man page Source code
.is_ratio Source code
.is_version_9 Man page Source code
.manage_parameter Source code
.manage_parameter_bc Source code
.removeCluster Source code
.remove_bc_api Source code
.split_nodalOptimization_by_target Man page Source code
.st_mandatory_params Source code
.tableAggregateload Source code
.testDT Source code
.updateData Source code
.updateStudyName Source code
.valueCheck Source code
.valueCheck870 Source code
.writeAntaresOutput Source code
.writeDT Source code
`%||%` Source code
activateRES Man page Source code
activateST Man page Source code
add_week_number_column_to_ts Man page Source code
adequacyOptions Man page Source code
antaresEditObject Man page
antaresEditObject-package Man page
api_command_execute Source code
api_command_generate Source code
api_command_register Source code
api_commands_generate Source code
api_get_raw_data Source code
api_get_variants Source code
api_not_implemented Source code
api_patch Man page Source code
backupStudy Man page Source code
badge_api_no Source code
badge_api_ok Source code
check-version Man page
checkRemovedArea Man page Source code
check_active_RES Source code
check_active_ST Source code
check_api_study Source code
check_area_name Source code
check_consistency_reservoir_values Man page Source code
check_mingen_vs_hydro_storage Man page Source code
check_mingen_vs_maxpower Man page Source code
check_param_RES Source code
check_param_links Source code
check_param_modal Source code
check_variant Source code
cleanUpOutput Man page Source code
clearScenarioBuilder Man page Source code
cli_command_registered Source code
computeOtherFromHourlyMulti Man page Source code
computeOtherFromHourlyYear Man page Source code
computeTimeStampFromHourly Man page Source code
convertConfigToAdq Man page Source code
copyOutput Man page Source code
copyStudyWeb Man page Source code
cpt_timstamp Source code
create-study Man page
createArea Man page Source code
createBindingConstraint Man page Source code
createBindingConstraintBulk Man page Source code
createBindingConstraint_ Source code
createCluster Man page Source code
createClusterBulk Man page Source code
createClusterRES Man page Source code
createClusterST Man page Source code
createDSR Man page Source code
createDistrict Man page Source code
createLink Man page Source code
createPSP Man page Source code
createStudy Man page Source code
createStudyAPI Man page Source code
createVariant Man page Source code
create_scb_referential_series_type Man page Source code
deduplicateScenarioBuilder Man page Source code
deleteStudy Man page Source code
detect_pattern_in_binding_constraint Man page Source code
dicoAdequacySettings Man page Source code
dicoGeneralSettings Man page Source code
dicoOptimizationSettings Man page Source code
dicoOutputSettings Man page Source code
dropNulls Source code
editArea Man page Source code
editBindingConstraint Man page Source code
editCluster Man page Source code
editClusterRES Man page Source code
editClusterST Man page Source code
editDSR Man page Source code
editLink Man page Source code
editPSP Man page Source code
extract_el Source code
fill_empty_hydro_ini_file Man page Source code
fill_empty_hydro_ts_file Man page Source code
filteringOptions Man page Source code
generate_cluster_name Source code
getCapacityDSR Man page Source code
getCapacityPSP Man page Source code
getJobLogs Man page Source code
getJobs Man page Source code
getPlaylist Man page Source code
getVariantCommands Man page Source code
get_default_hydro_ini_values Man page Source code
get_type_check_mingen_vs_hydrostorage Man page Source code
get_type_check_mingen_vs_hydrostorage_to_trigger Man page Source code
get_type_check_mingen_vs_maxpower_to_trigger Man page Source code
group_values_meta_check Man page Source code
hyphenize_names Source code
importZipStudyWeb Man page Source code
initialize_RES Source code
initialize_ST Source code
is_active_RES Source code
is_antares_v7 Man page Source code
is_antares_v820 Man page Source code
is_api_mocked Source code
is_api_study Source code
is_different Source code
is_named Source code
is_quiet Source code
is_study_path Source code
is_variant Source code
keep_last_element_from_named_list Source code
linksAsDT Source code
list_pollutants_values Man page Source code
listify_sb Source code
mockSimulationAPI Man page Source code
nodalOptimizationOptions Man page Source code
playlist Man page
print.antares.api.command Source code
print.antares.api.commands Source code
print.antares.api.logs Source code
propertiesLinkOptions Man page Source code
readScenarioBuilder Man page Source code
removeArea Man page Source code
removeBindingConstraint Man page Source code
removeCluster Man page Source code
removeClusterRES Man page Source code
removeClusterST Man page Source code
removeLink Man page Source code
rename_floor_list Source code
replicate_missing_ts Man page Source code
rollback_to_previous_data Man page Source code
runSimulation Man page Source code
runTsGenerator Man page Source code
scenario-builder Man page
scenarioBuilder Man page Source code
searchStudy Man page Source code
setAPImode Man page Source code
setPlaylist Man page Source code
setSolverPath Man page Source code
should_command_be_executed Source code
storage_values_default Man page Source code
switch_to_list_name_operator_870 Source code
transform_name_to_id Source code
updateAdequacySettings Man page Source code
updateGeneralSettings Man page Source code
updateInputSettings Man page Source code
updateOptimizationSettings Man page Source code
updateOutputSettings Man page Source code
updateScenarioBuilder Man page Source code
update_api_opts Source code
update_generaldata_by_section Man page Source code
update_opts Source code
useVariant Man page Source code
validate_area_name Source code
variant Man page
variant-commands Man page
write-ini Man page
writeEconomicOptions Man page Source code
writeHydroValues Man page Source code
writeIni Man page Source code
writeIniAPI Man page Source code
writeIniFile Man page Source code
writeIniHydro Man page Source code
writeInputTS Man page Source code
writeMiscGen Man page Source code
writeOutputValues Man page Source code
writeSeriesPrepro Man page Source code
writeVariantCommands Man page Source code
writeWaterValues Man page Source code
antaresEditObject documentation built on April 4, 2025, 4:25 a.m.