Edit an 'Antares' Simulation


[Up] [Top]

Documentation for package ‘antaresEditObject’ version 0.5.1

Help Pages

activateRES Activate RES in an Antares study
adequacyOptions Adequacy patch parameters for creating an area
backupStudy Create a backup with an Antares Study
check-version Is study an Antares v7 study ?
checkRemovedArea Seek for a removed area
cleanUpOutput Clean up output based on geographic trimming
clearScenarioBuilder Read, create & update scenario builder
computeOtherFromHourlyMulti Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)
computeOtherFromHourlyYear Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)
computeTimeStampFromHourly Compute daily, weekly, monthly and annual mc-ind from hourly data.
convertConfigToAdq Read adequacy patch config.yml into Antares (v8.5+)
copyOutput Copy of the output files of an Antares study
copyStudyWeb Import physical study to Antares Web (managed study)
create-binding-constraint Create a binding constraint
create-cluster Create a cluster
create-study Create an empty Antares study
createArea Create an area in an Antares study
createBindingConstraint Create a binding constraint
createBindingConstraintBulk Create a binding constraint
createCluster Create a cluster
createClusterBulk Create serial thermal cluster
createClusterRES Create a cluster
createDistrict Create a district
createDSR Create a Demand Side Response (DSR)
createLink Create a link between two areas
createPSP Create a Pumped Storage Power plant (PSP)
createStudy Create an empty Antares study
createStudyAPI Create an empty Antares study
createVariant Create a study's variant
deleteStudy Delete a study
dicoGeneralSettings Correspondence between arguments of 'updateGeneralSettings' and actual Antares parameters.
dicoOptimizationSettings Correspondence between arguments of 'updateOptimizationSettings' and actual Antares parameters.
edit-cluster Edit an existing cluster
editArea Edit an area in an Antares study
editBindingConstraint Update an existing binding constraint
editCluster Edit an existing cluster
editClusterRES Edit an existing cluster
editDSR Create a Demand Side Response (DSR)
editLink Edit a link between two areas
editPSP Create a Pumped Storage Power plant (PSP)
filteringOptions Output profile options for creating an area
getCapacityDSR Create a Demand Side Response (DSR)
getCapacityPSP Create a Pumped Storage Power plant (PSP)
getJobLogs Retrieve job log from API
getJobs Retrieve API jobs
getPlaylist Get the playlist of an Antares study Antares API: *OK*
getVariantCommands Get API commands generated
is_antares_v7 Is study an Antares v7 study ?
is_antares_v820 Is study an Antares v7 study ?
mockSimulationAPI Mock API usage
nodalOptimizationOptions Nodal optimization parameters for creating an area
playlist Get the playlist of an Antares study Antares API: *OK*
propertiesLinkOptions Properties for creating a link
readScenarioBuilder Read, create & update scenario builder
remove-cluster Remove a cluster
removeArea Remove an area from an Antares study
removeBindingConstraint Remove a Binding Constraint
removeCluster Remove a cluster
removeClusterRES Remove a cluster
removeLink Remove a link between two areas
runSimulation Run an Antares Simulation
runTsGenerator Run Time-Series Generator
scenario-builder Read, create & update scenario builder
scenarioBuilder Read, create & update scenario builder
searchStudy Search study in AntaREST
setAPImode Set API mode
setPlaylist Get the playlist of an Antares study Antares API: *OK*
setSolverPath Set path to Antares Solver
updateAdequacySettings Update adequacy parameters of an Antares study
updateGeneralSettings Update general parameters of an Antares study
updateInputSettings Update input parameters of an Antares study
updateOptimizationSettings Update optimization parameters of an Antares study
updateOutputSettings Update output parameters of an Antares study
updateScenarioBuilder Read, create & update scenario builder
useVariant Create a study's variant
variant Create a study's variant
variant-commands Get API commands generated
write-ini Write configuration options in file or API
writeEconomicOptions Write Economic Options
writeHydroValues Write Hydro Values
writeIni Write configuration options in file or API
writeIniAPI Write configuration options in file or API
writeIniFile Write configuration options in file or API
writeInputTS Write input time series
writeMiscGen Write Misc Gen data
writeOutputValues Write output value for Antares
writeSeriesPrepro Write prepro data
writeVariantCommands Get API commands generated
writeWaterValues Write water values