diff --git a/docs/user-guide/2-variant_manager.md b/docs/user-guide/2-variant_manager.md index 892a57b524..4a7b6dbcfc 100644 --- a/docs/user-guide/2-variant_manager.md +++ b/docs/user-guide/2-variant_manager.md @@ -53,31 +53,9 @@ The example provided bellow demonstrates the creation of two areas and a link be ## Command list -### Base commands - -| Action Name | Arguments | Description | -|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| update_config |
{
target: <INI_TARGET>
data: <INI_MODEL>
}
| Update arbitrary config | -| replace_matrix |
{
target: <INPUT_SERIES_MATRIX>
matrix: <MATRIX>
}
| Replace arbitrary matrix | -| create_area |
{
area_name: <STRING>
}
| Create a new area | -| remove_area |
{
id: <AREA_ID>
}
| Remove an existing area | -| create_cluster |
{
area_id: <AREA_ID>
cluster_name: <STRING>
prepro?: <STRING>
modulation?: <MATRIX>
parameters?: <INI_MODEL>
}
| Create a new thermal cluster | -| remove_cluster |
{
area_id: <AREA_ID>
cluster_id: <CLUSTER_ID>
}
| Remove an existing thermal cluster | -| create_renewables_cluster |
{
area_id: <AREA_ID>
cluster_name: <STRING>
parameters?: <INI_MODEL>
}
| Create a new renewable cluster | -| remove_renewables_cluster |
{
area_id: <AREA_ID>
cluster_id: <CLUSTER_ID>
}
| Remove an existing renewable cluster | -| create_link |
{
area1: <AREA_ID>
area2: <AREA_ID>
parameters?: <INI_MODEL>
series?: <MATRIX>
}
| Create a new link | -| remove_link |
{
area1: <AREA_ID>
area2: <AREA_ID>
}
| Remove an existing link | -| create_district |
{
name: <STRING>
base_filter?: "add-all" | "remove-all"
filter_items?: <LIST[AREA_ID]>
output?: <BOOLEAN> (default: True)
comments?: <STRING>
}
| Create a new district (set of areas) | -| remove_district |
{
id: <DISTRICT_ID>
}
| Remove an existing district | -| create_binding_constraint |
{
name: <STRING>
enabled?: <BOOLEAN> (default: True)
time_step: "hourly" | "weekly" | "daily"
operator: "equal" | "both" | "greater" | "less"
coeffs: <LIST[CONSTRAINT_COEFF]>
values?: <MATRIX>
comments?: <STRING>
}

CONSTRAINT_COEFF
{
type: <"cluster" | "link" (choosing one or the other imply filling the right corresponding parameter below)>
link: <AREA_ID>%<AREA_ID> (link)
cluster: <AREA_ID>.<CLUSTER_ID>
coeff: <NUMBER>
offset?: <NUMBER>
}
| Create a new binding constraint | -| update_binding_constraint |
{
id: <BINDING_CONSTRAINT_ID>
enabled?: <BOOLEAN> (default: True)
time_step: "hourly" | "weekly" | "daily"
operator: "equal" | "both" | "greater" | "less"
coeffs: <LIST[CONSTRAINT_COEFF]>
values?: <MATRIX>
comments?: <STRING>
}
| Update an existing binding constraint | -| remove_binding_constraint |
{
id: <BINDING_CONSTRAINT_ID>
}
| Remove an existing binding constraint | -| update_playlist |
{
active: <BOOLEAN> (default: True)
reverse: <BOOLEAN> (default: False)
items: <LIST[NUMBER]> (default: None)
}
| Update the playlist with provided active (or inactive) years (starting from year 1) | -| update_scenario_builder |
{
data: <RULESETS_MODEL>
}
| Update scenario builder with partial configuration | -| update_district |
{
id: <STRING>
base_filter?: "add-all" | "remove-all"
filter_items?: <LIST[AREA_ID]>
output?: <BOOLEAN> (default: True)
comments?: <STRING>
}
| Update a district (set of areas) | -| update_raw_file |
{
target: <INPUT_RAW_FILE_TARGET>
b64Data: <STRING>
}
| Replace arbitrary data file (must not be a matrix or ini target) with a base64 encoded data | - -#### Base types +### Base types + +The following table describes the data types used in the commands: | Type | Description | |----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -89,11 +67,289 @@ The example provided bellow demonstrates the creation of two areas and a link be | RULESETS_MODEL | like `INI_MODEL` with some specifications: an empty string allows to remove a key (ruleset or cell value) and a ruleset "A" with for value the name of an another ruleset "B" allows to clone the content of "B" in "A" | | INPUT_RAW_FILE_TARGET | a valid antares raw data file relative path (without extension). The path can be found when browsing the study in detailed view | | INPUT_SERIES_MATRIX_TARGET | a valid antares matrix data file relative path (without extension). The path can be found when browsing the study in detailed view | -| MATRIX | a matrix id or a list of list of values (eg. [[0,1,2],[4,5,6]] where each sub list is a row of the matrix). Matrix id can be found in the Matrix Data manager tab. | -| AREA_ID | the id of an area (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | -| CLUSTER_ID | the id of a cluster (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | -| DISTRICT_ID | the id of a district (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | -| BINDING_CONSTRAINT_ID | the id of a binding constraint (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | +| MATRIX | a matrix id or a list of list of values (eg. [[0,1,2],[4,5,6]] where each sub list is a row of the matrix). Matrix ID can be found in the Matrix Data manager tab. | +| AREA_ID | the ID of an area (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | +| CLUSTER_ID | the ID of a cluster (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | +| STORAGE_ID | the ID of a short-term storage (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | +| DISTRICT_ID | the ID of a district (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | +| BINDING_CONSTRAINT_ID | the ID of a binding constraint (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) | + +### `update_config` + +Update arbitrary config + +```json +{ + "target": "", + "data": "" +} +``` + +### `replace_matrix` + +Replace arbitrary matrix + +```json +{ + "target": "", + "matrix": "" +} +``` + +### `create_area` + +Create a new area + +```json +{ + "area_name": "" +} +``` + +### `remove_area` + +Remove an existing area + +```json +{ + "id": "" +} +``` + +### `create_cluster` + +Create a new thermal cluster + +```json +{ + "area_id": "", + "cluster_name": "", + "parameters": "", + "prepro?": "", + "modulation?": "" +} +``` + +### `remove_cluster` + +Remove an existing thermal cluster + +```json +{ + "area_id": "", + "cluster_id": "" +} +``` + +### `create_renewables_cluster` + +Create a new renewable cluster + +```json +{ + "area_id": "", + "cluster_name": "", + "parameters": "" +} +``` + +### `remove_renewables_cluster` + +Remove an existing renewable cluster + +```json +{ + "area_id": "", + "cluster_id": "" +} +``` + +### `create_link` + +Create a new link + +```json +{ + "area1": "", + "area2": "", + "parameters": "", + "series?": "" +} +``` + +### `remove_link` + +Remove an existing link + +```json +{ + "area1": "", + "area2": "" +} +``` + +### `create_district` + +Create a new district (set of areas) + +```json +{ + "name": "", + "base_filter?": "'add-all' | 'remove-all'", + "filter_items?": "", + "output?": " (default: True)", + "comments?": "" +} +``` + +### `remove_district` + +Remove an existing district + +```json +{ + "id": "" +} +``` + +### `create_binding_constraint` + +Create a new binding constraint + +```json +{ + "name": "", + "enabled?": " (default: True)", + "time_step": "'hourly' | 'weekly' | 'daily'", + "operator": "'equal' | 'both' | 'greater' | 'less'", + "coeffs": "", + "values?": "", + "comments?": "" +} +``` + +Where cluster `CONSTRAINT_COEFF` is: + +```json +{ + "type": "cluster", + "cluster": ".", + "coeff": "", + "offset?": "" +} +``` + +Or link `CONSTRAINT_COEFF` is: + +```json +{ + "type": "link", + "link": "%", + "coeff": "", + "offset?": "" +} +``` + +### `update_binding_constraint` + +Update an existing binding constraint + +```json +{ + "id": "", + "enabled?": " (default: True)", + "time_step": "'hourly' | 'weekly' | 'daily'", + "operator": "'equal' | 'both' | 'greater' | 'less'", + "coeffs": "", + "values?": "", + "comments?": "" +} +``` + +### `remove_binding_constraint` + +Remove an existing binding constraint + +```json +{ + "id": "" +} +``` + +### `update_playlist` + +Update the playlist with provided active (or inactive) years (starting from year 1) + +```json +{ + "active": " (default: True)", + "reverse": " (default: False)", + "items": " (default: None)" +} +``` + +### `update_scenario_builder` + +Update scenario builder with partial configuration + +```json +{ + "data": "" +} +``` + +### `update_district` + +Update a district (set of areas) + +```json +{ + "id": "", + "base_filter?": "'add-all' | 'remove-all'", + "filter_items?": "", + "output?": " (default: True)", + "comments?": "" +} +``` + +### `update_raw_file` + +Replace arbitrary data file (must not be a matrix or ini target) with a base64 encoded data + +```json +{ + "target": "", + "b64Data": "" +} +``` + +### `create_st_storage` + +Create a new short-term storage + +```json +{ + "area_id": "", + "storage_name": "", + "parameters": "", + "pmax_injection?": "", + "pmax_withdrawal?": "", + "lower_rule_curve?": "", + "upper_rule_curve?": "", + "inflows?": "" +} +``` + +### `remove_st_storage` + +Remove an existing short-term storage + +```json +{ + "area_id": "", + "storage_id": "" +} +``` ### Specialized commands