diff --git a/docs/architecture/5-roadmap.md b/docs/architecture/5-roadmap.md deleted file mode 100644 index 28d9477bae..0000000000 --- a/docs/architecture/5-roadmap.md +++ /dev/null @@ -1 +0,0 @@ -#Roadmap \ No newline at end of file diff --git a/docs/assets/media/img/installer_screenshot.png b/docs/assets/media/img/installer_screenshot.png new file mode 100644 index 0000000000..dbb6c138c6 Binary files /dev/null and b/docs/assets/media/img/installer_screenshot.png differ diff --git a/docs/assets/media/img/userguide_change_language.png b/docs/assets/media/img/userguide_change_language.png new file mode 100644 index 0000000000..482f8fa688 Binary files /dev/null and b/docs/assets/media/img/userguide_change_language.png differ diff --git a/docs/assets/media/img/userguide_token_creation.png b/docs/assets/media/img/userguide_token_creation.png index 7d88161322..f383f909f7 100644 Binary files a/docs/assets/media/img/userguide_token_creation.png and b/docs/assets/media/img/userguide_token_creation.png differ diff --git a/docs/assets/media/img/userguide_token_listing.png b/docs/assets/media/img/userguide_token_listing.png index b88d73c59b..271fb771ff 100644 Binary files a/docs/assets/media/img/userguide_token_listing.png and b/docs/assets/media/img/userguide_token_listing.png differ diff --git a/docs/assets/media/img/userguide_token_result.png b/docs/assets/media/img/userguide_token_result.png index 623202e23d..971b9c5421 100644 Binary files a/docs/assets/media/img/userguide_token_result.png and b/docs/assets/media/img/userguide_token_result.png differ diff --git a/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-tab.png b/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-tab.png new file mode 100644 index 0000000000..9d5b8cc17c Binary files /dev/null and b/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-tab.png differ diff --git a/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming1.png b/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming1.png new file mode 100644 index 0000000000..a12b4b8839 Binary files /dev/null and b/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming1.png differ diff --git a/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming2.png b/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming2.png new file mode 100644 index 0000000000..ba40b75f33 Binary files /dev/null and b/docs/assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming2.png differ diff --git a/docs/assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management1.png b/docs/assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management1.png new file mode 100644 index 0000000000..bab6242cf0 Binary files /dev/null and b/docs/assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management1.png differ diff --git a/docs/assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management2.png b/docs/assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management2.png new file mode 100644 index 0000000000..1fa51672e8 Binary files /dev/null and b/docs/assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management2.png differ diff --git a/docs/assets/media/user-guide/study/01-map-tab.png b/docs/assets/media/user-guide/study/01-map-tab.png new file mode 100644 index 0000000000..a8ee1b1daf Binary files /dev/null and b/docs/assets/media/user-guide/study/01-map-tab.png differ diff --git a/docs/assets/media/user-guide/study/01-map.tab.png b/docs/assets/media/user-guide/study/01-map.tab.png deleted file mode 100644 index 7890e89799..0000000000 Binary files a/docs/assets/media/user-guide/study/01-map.tab.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/02-areas-tab.png b/docs/assets/media/user-guide/study/02-areas-tab.png new file mode 100644 index 0000000000..2bb583cfc4 Binary files /dev/null and b/docs/assets/media/user-guide/study/02-areas-tab.png differ diff --git a/docs/assets/media/user-guide/study/02-areas.tab.png b/docs/assets/media/user-guide/study/02-areas.tab.png deleted file mode 100644 index 94e2b29a15..0000000000 Binary files a/docs/assets/media/user-guide/study/02-areas.tab.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/03-links-tab.png b/docs/assets/media/user-guide/study/03-links-tab.png new file mode 100644 index 0000000000..3d1670bee9 Binary files /dev/null and b/docs/assets/media/user-guide/study/03-links-tab.png differ diff --git a/docs/assets/media/user-guide/study/03-links.tab.png b/docs/assets/media/user-guide/study/03-links.tab.png deleted file mode 100644 index 0f6771de6d..0000000000 Binary files a/docs/assets/media/user-guide/study/03-links.tab.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/04-binding-constraints-tab.png b/docs/assets/media/user-guide/study/04-binding-constraints-tab.png new file mode 100644 index 0000000000..40569ada9f Binary files /dev/null and b/docs/assets/media/user-guide/study/04-binding-constraints-tab.png differ diff --git a/docs/assets/media/user-guide/study/04-binding-constraints.tab.png b/docs/assets/media/user-guide/study/04-binding-constraints.tab.png deleted file mode 100644 index 4fdae52ef5..0000000000 Binary files a/docs/assets/media/user-guide/study/04-binding-constraints.tab.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/05-debug-tab.png b/docs/assets/media/user-guide/study/05-debug-tab.png new file mode 100644 index 0000000000..7b764e2d20 Binary files /dev/null and b/docs/assets/media/user-guide/study/05-debug-tab.png differ diff --git a/docs/assets/media/user-guide/study/05-debug.tab.png b/docs/assets/media/user-guide/study/05-debug.tab.png deleted file mode 100644 index 59ae230307..0000000000 Binary files a/docs/assets/media/user-guide/study/05-debug.tab.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/06-table-mode-tab.png b/docs/assets/media/user-guide/study/06-table-mode-tab.png new file mode 100644 index 0000000000..7f2d417609 Binary files /dev/null and b/docs/assets/media/user-guide/study/06-table-mode-tab.png differ diff --git a/docs/assets/media/user-guide/study/06-table-mode.tab.png b/docs/assets/media/user-guide/study/06-table-mode.tab.png deleted file mode 100644 index 064e2b9b82..0000000000 Binary files a/docs/assets/media/user-guide/study/06-table-mode.tab.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/07-map-layers-districts.png b/docs/assets/media/user-guide/study/07-map-layers-districts.png new file mode 100644 index 0000000000..aa44f2c0cb Binary files /dev/null and b/docs/assets/media/user-guide/study/07-map-layers-districts.png differ diff --git a/docs/assets/media/user-guide/study/08-layers-districts.png b/docs/assets/media/user-guide/study/08-layers-districts.png new file mode 100644 index 0000000000..523df53a52 Binary files /dev/null and b/docs/assets/media/user-guide/study/08-layers-districts.png differ diff --git a/docs/assets/media/user-guide/study/09-results-view.png b/docs/assets/media/user-guide/study/09-results-view.png new file mode 100644 index 0000000000..34641ff906 Binary files /dev/null and b/docs/assets/media/user-guide/study/09-results-view.png differ diff --git a/docs/assets/media/user-guide/study/areas/01-properties-form.png b/docs/assets/media/user-guide/study/areas/01-properties-form.png index 55c3afe312..1de7bae70f 100644 Binary files a/docs/assets/media/user-guide/study/areas/01-properties-form.png and b/docs/assets/media/user-guide/study/areas/01-properties-form.png differ diff --git a/docs/assets/media/user-guide/study/areas/03-thermals-form.png b/docs/assets/media/user-guide/study/areas/03-thermals-form.png new file mode 100644 index 0000000000..f7ba893ac4 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/03-thermals-form.png differ diff --git a/docs/assets/media/user-guide/study/areas/03-thermals-series.png b/docs/assets/media/user-guide/study/areas/03-thermals-series.png new file mode 100644 index 0000000000..80ad1ec135 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/03-thermals-series.png differ diff --git a/docs/assets/media/user-guide/study/areas/03-thermals.form.png b/docs/assets/media/user-guide/study/areas/03-thermals.form.png deleted file mode 100644 index ac431175c3..0000000000 Binary files a/docs/assets/media/user-guide/study/areas/03-thermals.form.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/areas/03-thermals.series.png b/docs/assets/media/user-guide/study/areas/03-thermals.series.png deleted file mode 100644 index 90fbca354b..0000000000 Binary files a/docs/assets/media/user-guide/study/areas/03-thermals.series.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/areas/04-renewables-activation.png b/docs/assets/media/user-guide/study/areas/04-renewables-activation.png new file mode 100644 index 0000000000..027dfe11c1 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/04-renewables-activation.png differ diff --git a/docs/assets/media/user-guide/study/areas/05-hydro-allocation.png b/docs/assets/media/user-guide/study/areas/05-hydro-allocation.png new file mode 100644 index 0000000000..b0c2b59af2 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/05-hydro-allocation.png differ diff --git a/docs/assets/media/user-guide/study/areas/05-hydro-correlation.png b/docs/assets/media/user-guide/study/areas/05-hydro-correlation.png new file mode 100644 index 0000000000..c96dc6bc04 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/05-hydro-correlation.png differ diff --git a/docs/assets/media/user-guide/study/areas/05-hydro-dailypower-energycredits.png b/docs/assets/media/user-guide/study/areas/05-hydro-dailypower-energycredits.png new file mode 100644 index 0000000000..30d4786f67 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/05-hydro-dailypower-energycredits.png differ diff --git a/docs/assets/media/user-guide/study/areas/05-hydro-inflowstructure.png b/docs/assets/media/user-guide/study/areas/05-hydro-inflowstructure.png new file mode 100644 index 0000000000..8d0d01a365 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/05-hydro-inflowstructure.png differ diff --git a/docs/assets/media/user-guide/study/areas/06-wind-activation.png b/docs/assets/media/user-guide/study/areas/06-wind-activation.png new file mode 100644 index 0000000000..008af0955f Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/06-wind-activation.png differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages-form.png b/docs/assets/media/user-guide/study/areas/08-st-storages-form.png new file mode 100644 index 0000000000..ade8f46600 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/08-st-storages-form.png differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages-list-enable.png b/docs/assets/media/user-guide/study/areas/08-st-storages-list-enable.png new file mode 100644 index 0000000000..ecca702e28 Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/08-st-storages-list-enable.png differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages-list.png b/docs/assets/media/user-guide/study/areas/08-st-storages-list.png new file mode 100644 index 0000000000..fe838f592e Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/08-st-storages-list.png differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages-series.png b/docs/assets/media/user-guide/study/areas/08-st-storages-series.png new file mode 100644 index 0000000000..5852d8953d Binary files /dev/null and b/docs/assets/media/user-guide/study/areas/08-st-storages-series.png differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages.form.png b/docs/assets/media/user-guide/study/areas/08-st-storages.form.png deleted file mode 100644 index a7be6236c1..0000000000 Binary files a/docs/assets/media/user-guide/study/areas/08-st-storages.form.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages.list.png b/docs/assets/media/user-guide/study/areas/08-st-storages.list.png deleted file mode 100644 index 213befc8e3..0000000000 Binary files a/docs/assets/media/user-guide/study/areas/08-st-storages.list.png and /dev/null differ diff --git a/docs/assets/media/user-guide/study/areas/08-st-storages.series.png b/docs/assets/media/user-guide/study/areas/08-st-storages.series.png deleted file mode 100644 index c8cfba6194..0000000000 Binary files a/docs/assets/media/user-guide/study/areas/08-st-storages.series.png and /dev/null differ diff --git a/docs/architecture/2-add-new-antares-version.md b/docs/developer-guide/2-add-new-antares-version.md similarity index 100% rename from docs/architecture/2-add-new-antares-version.md rename to docs/developer-guide/2-add-new-antares-version.md diff --git a/docs/developer-guide/5-roadmap.md b/docs/developer-guide/5-roadmap.md new file mode 100644 index 0000000000..2ebfeb47d7 --- /dev/null +++ b/docs/developer-guide/5-roadmap.md @@ -0,0 +1,2 @@ +# Roadmap +**_This section is under construction_** \ No newline at end of file diff --git a/docs/architecture/0-introduction.md b/docs/developer-guide/architecture/0-introduction.md similarity index 100% rename from docs/architecture/0-introduction.md rename to docs/developer-guide/architecture/0-introduction.md diff --git a/docs/architecture/1-database.md b/docs/developer-guide/architecture/1-database.md similarity index 100% rename from docs/architecture/1-database.md rename to docs/developer-guide/architecture/1-database.md diff --git a/docs/install/0-INSTALL.md b/docs/developer-guide/install/0-INSTALL.md similarity index 100% rename from docs/install/0-INSTALL.md rename to docs/developer-guide/install/0-INSTALL.md diff --git a/docs/install/1-CONFIG.md b/docs/developer-guide/install/1-CONFIG.md similarity index 100% rename from docs/install/1-CONFIG.md rename to docs/developer-guide/install/1-CONFIG.md diff --git a/docs/install/2-DEPLOY.md b/docs/developer-guide/install/2-DEPLOY.md similarity index 85% rename from docs/install/2-DEPLOY.md rename to docs/developer-guide/install/2-DEPLOY.md index 1136e24410..87df158b79 100644 --- a/docs/install/2-DEPLOY.md +++ b/docs/developer-guide/install/2-DEPLOY.md @@ -68,27 +68,28 @@ These steps should work on any linux system with docker and docker-compose insta This is an example of a deployment. You'll have to edit your own `docker-compose.yml` file and [`application.yaml` configuration](./1-CONFIG.md) to customize it to your needs. -## Local application build +## Local desktop application The local application is a bundled build of the web server to ease its launch as a kind of desktop application. -When started, the application will be shown as a systray application (icon in the bottom right corner of the Windows bar). The menu will allow to go -to the local address where the interface is available. +When started, the application will be shown as a systray application (icon in the bottom right corner of the Windows bar). The menu will allow to go to the local address where the interface is available. The build is directly available in the [release](https://github.com/AntaresSimulatorTeam/AntaREST/releases) files for each version. You can download the latest version here: -- [For Windows](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.5.0/AntaresWeb-windows-latest.zip) -- [For Ubuntu](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.5.0/AntaresWeb-ubuntu-latest.zip) +- [For Windows](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.18.0/AntaresWeb-windows-v2.18.0.zip) +- [For Ubuntu 20.04 ](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.18.0/AntaresWeb-ubuntu_20.04-v2.18.0.zip) +- [For Ubuntu 22.04](https://github.com/AntaresSimulatorTeam/AntaREST/releases/download/v2.18.0/AntaresWeb-ubuntu_22.04-v2.18.0.zip) The local application contains an installer program that you can use to manage the installation. This program will keep your local data while updating the functional parts of the server. ### GUI installer (windows only) -Double-click on the installer executable and follow the instructions. -In case you already have a local application, choose your current application path -in order to update it. +Double-click on the AntaresWebInstaller.exe executable and follow the instructions. +In case you already have a local application, choose your current application path in order to update it. + +![installer_screenshot.png](../../assets/media/img/installer_screenshot.png) ### CLI installer (linux only) diff --git a/docs/index.md b/docs/index.md index 4e1a2f818f..f7475b6d17 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,9 +33,9 @@ This integration brings: ## Documentation -- [Building the application](./install/0-INSTALL.md) +- [Building the application](./developer-guide/install/0-INSTALL.md) - [Using the application](./user-guide/0-introduction.md) -- [Contributing to the application code](./architecture/0-introduction.md) +- [Contributing to the application code](./developer-guide/architecture/0-introduction.md) `Antares-Web` is currently under development. Feel free to submit any issue. diff --git a/docs/user-guide/0-introduction.md b/docs/user-guide/0-introduction.md index de2bd50eb7..539ebb88bc 100644 --- a/docs/user-guide/0-introduction.md +++ b/docs/user-guide/0-introduction.md @@ -24,7 +24,7 @@ It enables detailed modeling of energy consumption, generation, and transportati across numerous year-long scenarios, each consisting of 8760 hourly time-frames. `antares-web` serves as a server API interfacing with Antares Simulator studies, providing a web application to manage -studies while adding features for enhanced edition capabilities. +studies while adding features for enhanced edition capabilities. It's also can be use in a local desktop application for one user, find the instruction about it [here](../developer-guide/install/2-DEPLOY.md#Local-application-build). This integration brings: diff --git a/docs/user-guide/1-interface.md b/docs/user-guide/1-interface.md index 38d1088a0c..b31ce600ed 100644 --- a/docs/user-guide/1-interface.md +++ b/docs/user-guide/1-interface.md @@ -14,11 +14,30 @@ tags: - dataset - batch - launch + - settings --- # User interface -## What's new (2.5.0) +## What's new (2.18.0) +- redesign of the debug view, with the possibility of importing files into the user folder. See more details [here](./study/05-debug.md) +- new endpoint for admin to clear snapshots +- update version of python to 3.11 +- time series generator for thermals clusters. See more details [here](../user-guide/simulation-configuration/all-configurations.md#time-series-management) +- installer for desktop version of Antares Web +- use .7z format to export and archive studies +- new component for matrix (Data Glide) +- adding column filters and search bar on results view +- enhance results columns headers +- adding aggregates columns on some matrix +- disable copy/paste on matrix +- allow csv import +- allow to change app language. See more details [here](#tabs-description) + +Antares Web is supporting antares simulator version untill v8.8.x. +For more details, see the changelog. + +## Main features of the interface - [Launch batch mode](#launch-batch-mode) - [Strict folder filtering](#strict-folder-filtering) @@ -146,9 +165,24 @@ The data which can be uploaded are either a single tsv file, or a zipped list of ![](../assets/media/img/userguide_dataset_creation.png) -## User account and api tokens +## Settings + +The settings are accessible in the menu on the left of the application. There are a total of 5 tabs that are visible depending on the user profile: +- the normal user has access to GENERAL and TOKENS tabs +- the administrator user of a group has access to the GROUPS tab in addition to the normal user tabs +- the server administrator has access to all tabs (USERS and MAINTENANCE tabs in addition to the others). + +### Tabs description +1. GENERAL: allows you to change the language of the application, two possible choices English or French +2. USERS: List of users on the server, you can create, delete or modify their permissions +3. GROUPS: List of user groups on the server, you can create, delete, modify its list of users or their permissions in the group +4. TOKENS: Allows you to create a token that will be used to access to APIs via scripts +5. MAINTENANCE: Allows you to put the server in maintenance mode, preventing other users other than the administrator from accessing the application. + +![userguide_change_language.png](../assets/media/img/userguide_change_language.png) + +### Create a token -For normal user, the account section allows the creation of "api token". These token can be used in scripts that will use the [API](#api-documentation). ![](../assets/media/img/userguide_token_listing.png) diff --git a/docs/user-guide/2-study.md b/docs/user-guide/2-study.md index 2db09dbbf4..a7f34715bb 100644 --- a/docs/user-guide/2-study.md +++ b/docs/user-guide/2-study.md @@ -1,5 +1,5 @@ --- -title: Study Configuration +title: Study Modelization author: Antares Web Team date: 2023-12-21 category: User Guide @@ -11,15 +11,13 @@ tags: - areas - links - binding-constraints - - debug - - table-mode --- -# Study Configuration +# Study Modelization -This page is dedicated to configuring the study in the Antares Web application. +This page is dedicated to modelize a study in the Antares Web application. -To access the configuration of the study: +To access the modelization of the study: 1. From the "Study" view, click on the "MODELIZATION" tab. @@ -29,5 +27,3 @@ To access the configuration of the study: - [Areas](study/02-areas.md) - [Links](study/03-links.md) - [Binding Constraints](study/04-binding-constraints.md) -- [Debug](study/05-debug.md) -- [Table Mode](study/06-table-mode.md) diff --git a/docs/how-to/studies-create.md b/docs/user-guide/how-to/studies-create.md similarity index 92% rename from docs/how-to/studies-create.md rename to docs/user-guide/how-to/studies-create.md index 8123872433..10e7a18d07 100644 --- a/docs/how-to/studies-create.md +++ b/docs/user-guide/how-to/studies-create.md @@ -24,7 +24,7 @@ This guide will walk you through the steps to create a new study, from initial s Navigate to the "Studies" pages to display the list of studies. Click on the "Create" button to open the "Create Study" dialog box. -![List of studies](../assets/media/how-to/study-create-button.png) +![List of studies](../../assets/media/how-to/study-create-button.png) ## Fill in Study Properties @@ -40,7 +40,7 @@ In the "Create Study" dialog, you will be prompted to enter details about your s - **Tag**: Add tags to your study to help categorize and organize it (enter each tag, and presse Ctrl+Enter to add it). -![Create Study Form](../assets/media/how-to/study-create-form.png) +![Create Study Form](../../assets/media/how-to/study-create-form.png) Validate the form by clicking the "Save" button. @@ -54,7 +54,7 @@ metadata. Select the `default` folder to display the list of studies in this folder. Click on the "More options" button of your study to access the "Properties" and "Move" options. -![Other Options Menu](../assets/media/how-to/study-create-other-options.png) +![Other Options Menu](../../assets/media/how-to/study-create-other-options.png) ### Move Study in a Subfolder @@ -63,7 +63,7 @@ The "Move Study" dialog opens, allowing you to select the destination folder. Enter the name of the subfolder and validate by clicking the "Save" button. -![Move Study Dialog](../assets/media/how-to/study-creation-move-to-subfolder.png) +![Move Study Dialog](../../assets/media/how-to/study-creation-move-to-subfolder.png) If the subfolder does not exist, it will be created automatically. @@ -81,7 +81,7 @@ The "Edit Study" dialog opens, allowing you to modify the study name, permission - **Tag**: Add tags to your study to help categorize and organize it (enter each tag, and presse Ctrl+Enter to add it). -![Edit Study Dialog](../assets/media/how-to/study-creation-edit-properties.png) +![Edit Study Dialog](../../assets/media/how-to/study-creation-edit-properties.png) Validate the form by clicking the "Save" button. @@ -151,7 +151,7 @@ Here is a breakdown of what each part of the code does: See also: -- ["User account & api tokens"](../user-guide/1-interface.md#user-account-and-api-tokens) in the user guide. +- ["User account & api tokens"](../1-interface.md#user-account-and-api-tokens) in the user guide. ## See also diff --git a/docs/how-to/studies-import.md b/docs/user-guide/how-to/studies-import.md similarity index 100% rename from docs/how-to/studies-import.md rename to docs/user-guide/how-to/studies-import.md diff --git a/docs/how-to/studies-upgrade.md b/docs/user-guide/how-to/studies-upgrade.md similarity index 100% rename from docs/how-to/studies-upgrade.md rename to docs/user-guide/how-to/studies-upgrade.md diff --git a/docs/user-guide/simulation-configuration/all-configurations.md b/docs/user-guide/simulation-configuration/all-configurations.md new file mode 100644 index 0000000000..8f9739fbe6 --- /dev/null +++ b/docs/user-guide/simulation-configuration/all-configurations.md @@ -0,0 +1,100 @@ +--- +title: Simulation Configuration +author: Antares Web Team +date: 2024-11-22 +category: User Guide +tags: + + - simulation configuration + - monte-carlo scenarios + - output profile + - calendar + - optimization preferences + +--- + +# Simulation Configuration +**_This section is under construction_** + +## Introduction + +This documentation is dedicated to configuring simulation in the Antares Web application. + +To access the configuration of simulation, from the "Study" view, click on the "CONFIGURATION" tab. + +All the configuration are here. + +## General configuration +To access the general configuration of a study : + +1. From the "Study" view, click on the "CONFIGURATION" tab. +2. The firt next tab is for general configuration. + +![01-configuration-general-tab.png](../../assets/media/user-guide/simulation-configuration/01-configuration-general-tab.png) + +Let’s focus on some options in this section. + +### Building mode +> TODO + +### Selection mode +> TODO + +### Geographic trimming +> TODO + +### Thematic trimming + +To access to the thematic trimming, when you are in general configuration : +1. Go to Output profile +2. In Thematic trimming drop-down list, choose "Custom" + +![01-configuration-general-themmatic-trimming1.png](../../assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming1.png) + +3. The SETTING option just to the right will be activated, click on it to access the thematic trimming configuration + +![01-configuration-general-themmatic-trimming2.png](../../assets/media/user-guide/simulation-configuration/01-configuration-general-themmatic-trimming2.png) + +The output variables are grouped by modeling objects (links, thermal clusters, etc.). + +On the thematic trimming window, you will find the following elements: + +- **Search bar:** You can search for specific variables, this will return all variables that match the criteria you entered in the search bar. +- **Selection option:** You will find options allowing you to activate or deactivate all the variables or even to fold all the variable groups. You can unfold a specific group manually. + +The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/stable/user-guide/ts-generator/04-parameters/#general-parameters). + +## Time-series management + +To access to Time-series management : +1. From the "Study" view, click on the "CONFIGURATION" tab +2. The second next tab is for time series management. + +![01-configuration-timeseries-management1.png](../../assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management1.png) + +In this view you can generate time series for all thermals clusters. Choose "To be Generated" and set the number stochastics TS you want. And clic on GENERATE TS. + +![01-configuration-timeseries-management2.png](../../assets/media/user-guide/simulation-configuration/02-configuration-timeseries-management2.png) + +It'll create a task you can monitor on the Tasks view. The TS generate are visible on Availability tab of the thermal cluster of the study. + +A new library [antares-timeseries-generation](https://github.com/AntaresSimulatorTeam/antares-timeseries-generation) was created to generate time series for clusters. + +## Optimization preferences +> TODO + +## Adequacy Patch +> TODO + +## Advanced parameters +> TODO + +## Economic Opt. +> TODO + +## Geographic Trimming (Areas) +> TODO +## Geographic Trimming (Links) +> TODO +## Geographic Trimming (Binding Constraints) +> TODO diff --git a/docs/user-guide/study/01-map.md b/docs/user-guide/study/01-map.md index 8cbfc94685..74517d1efd 100644 --- a/docs/user-guide/study/01-map.md +++ b/docs/user-guide/study/01-map.md @@ -1,6 +1,19 @@ -# Study Map +--- +title: Study Map +author: Antares Web Team +date: 2024-11-21 +category: User Guide +tags: + + - simulation modelization + - map + - links + - areas + - layers + - districts -[⬅ Study Configuration](../2-study.md) +--- +# Study Map This page allows you to sketch the production and consumption network of your study. You can add, edit, and delete nodes and links. @@ -10,4 +23,16 @@ To access the map of the study: 1. From the "Study" view, click on the "MODELIZATION" tab. 2. Click on the "MAP" tab to access the page dedicated to the map. -![01-map.tab.png](../../assets/media/user-guide/study/01-map.tab.png) +![01-map-tab.png](../../assets/media/user-guide/study/01-map-tab.png) + +## Layers and districts +You can also add, edit and deleate layers and districts here. +Go to bottom right of the web page and clic on the gear icon. + +![07-map-layers-districts.png](../../assets/media/user-guide/study/07-map-layers-districts.png) + +And this page will be opened. To delete a layer ou a district, clic on Edit. + +![08-layers-districts.png](../../assets/media/user-guide/study/08-layers-districts.png) + +[⬅ Back to Study Modelization](../2-study.md) \ No newline at end of file diff --git a/docs/user-guide/study/02-areas.md b/docs/user-guide/study/02-areas.md index 10cb737302..df8a83db28 100644 --- a/docs/user-guide/study/02-areas.md +++ b/docs/user-guide/study/02-areas.md @@ -1,7 +1,5 @@ # Area Configuration -[⬅ Study Configuration](../2-study.md) - This page is dedicated to configuring areas in the Antares Web application. To access the configuration of areas: @@ -9,7 +7,7 @@ To access the configuration of areas: 1. From the "Study" view, click on the "MODELIZATION" tab. 2. Click on the "AREAS" tab to access the page dedicated to areas. -![02-areas.tab.png](../../assets/media/user-guide/study/02-areas.tab.png) +![02-areas-tab.png](../../assets/media/user-guide/study/02-areas-tab.png) ## Main Topics @@ -23,3 +21,5 @@ To access the configuration of areas: - [Short-Term Storages](areas/08-st-storages.md) - [Reserves](areas/09-reserves.md) - [Miscellaneous Generators](areas/10-misc-gen.md) + +[⬅ Study Configuration](../2-study.md) diff --git a/docs/user-guide/study/03-links.md b/docs/user-guide/study/03-links.md index 1c53563170..e63ba273ac 100644 --- a/docs/user-guide/study/03-links.md +++ b/docs/user-guide/study/03-links.md @@ -1,7 +1,5 @@ # Links Configuration -[⬅ Study Configuration](../2-study.md) - This page is dedicated to configuring links in the Antares Web application. To access the configuration of areas: @@ -9,5 +7,7 @@ To access the configuration of areas: 1. From the "Study" view, click on the "MODELIZATION" tab. 2. Click on the "AREAS" tab to access the page dedicated to links. -![03-links.tab.png](../../assets/media/user-guide/study/03-links.tab.png) +![03-links-tab.png](../../assets/media/user-guide/study/03-links-tab.png) + +[⬅ Back to Study Configuration](../2-study.md) diff --git a/docs/user-guide/study/04-binding-constraints.md b/docs/user-guide/study/04-binding-constraints.md index ff0b78c926..c6948909f0 100644 --- a/docs/user-guide/study/04-binding-constraints.md +++ b/docs/user-guide/study/04-binding-constraints.md @@ -1,7 +1,5 @@ # Binding Constraints Configuration -[⬅ Study Configuration](../2-study.md) - This page is dedicated to configuring binding constraints in the Antares Web application. To access the configuration of binding constraints: @@ -9,4 +7,6 @@ To access the configuration of binding constraints: 1. From the "Study" view, click on the "MODELIZATION" tab. 2. Click on the "BINDING CONSTRAINTS" tab to access the page dedicated to binding constraints. -![04-binding-constraints.tab.png](../../assets/media/user-guide/study/04-binding-constraints.tab.png) +![04-binding-constraints-tab.png](../../assets/media/user-guide/study/04-binding-constraints-tab.png) + +[⬅ Back to Study Configuration](../2-study.md) diff --git a/docs/user-guide/study/05-debug.md b/docs/user-guide/study/05-debug.md index 8c2caaaa44..65a2722c68 100644 --- a/docs/user-guide/study/05-debug.md +++ b/docs/user-guide/study/05-debug.md @@ -1,12 +1,12 @@ # Debug View - -[⬅ Study Configuration](../2-study.md) +**_This section is under construction_** This page is dedicated to the debugging of the study in the Antares Web application. To access the debug view: -1. From the "Study" view, click on the "MODELIZATION" tab. -2. Click on the "DEBUG" tab to access the page dedicated to debugging. +1. From the "Study" view, click on the "DEBUG" tab to access the page dedicated to debugging. + +![05-debug-tab.png](../../assets/media/user-guide/study/05-debug-tab.png) -![05-debug.tab.png](../../assets/media/user-guide/study/05-debug.tab.png) +[⬅ Back to Study Configuration](../2-study.md) \ No newline at end of file diff --git a/docs/user-guide/study/06-table-mode.md b/docs/user-guide/study/06-table-mode.md index 53c97ecea2..7727c9ab72 100644 --- a/docs/user-guide/study/06-table-mode.md +++ b/docs/user-guide/study/06-table-mode.md @@ -1,12 +1,14 @@ # Table Mode -[⬅ Study Configuration](../2-study.md) - This page is dedicated to the table mode, which allows you to edit the study properties in a tables. To access the table mode: -1. From the "Study" view, click on the "MODELIZATION" tab. -2. Click on the "TABLE MODE" tab to access the page dedicated to the table mode. +1. From the "Study" view, click on the "TABLE MODE" tab to access the page dedicated to the table mode. + +![06-table-mode-tab.png](../../assets/media/user-guide/study/06-table-mode-tab.png) + +**_This section is under construction_** +> TODO : Describe here the operation and use of modeling tables. -![06-table-mode.tab.png](../../assets/media/user-guide/study/06-table-mode.tab.png) +[⬅ Back to Study Configuration](../2-study.md) \ No newline at end of file diff --git a/docs/user-guide/study/07-xpansion.md b/docs/user-guide/study/07-xpansion.md new file mode 100644 index 0000000000..b88fafa754 --- /dev/null +++ b/docs/user-guide/study/07-xpansion.md @@ -0,0 +1,14 @@ +--- +title: Xpansion +author: Antares Web Team +date: 2024-11-22 +category: User Guide +tags: + + - xpansion + +--- + +# Xpansion +**_This section is under construction_** +> TODO : describe here the xpansion view \ No newline at end of file diff --git a/docs/user-guide/study/08-results.md b/docs/user-guide/study/08-results.md new file mode 100644 index 0000000000..5fb22cd8b5 --- /dev/null +++ b/docs/user-guide/study/08-results.md @@ -0,0 +1,33 @@ +--- +title: Results +author: Antares Web Team +date: 2024-11-22 +category: User Guide +tags: + + - results + - output + - simulation results + +--- + +# Results +**_This section is under construction_** + +This page is dedicated to the results of a simulation. + +To access results : + +1. From the "Study" view, click on the "RESULTS" tab. + +![09-results-view.png](../../assets/media/user-guide/study/09-results-view.png) + +On the results page, you will find the following elements: + +- **Toolbar:** Use the toolbar to filter and quickly search in the matrix results +- **Monte-Carlo filter output profile:** choose between Synthesis ou Year-by-year output +- **Display:** choose betwen Geneal values, Thermal plants, Ren. clusters, RecordYear ou ST Storages +- **Temporality:** choose between Hourly, Daily, Weekly, Monthly or Annuel +- **EXPORT button:** You can choose to export a specfic output matrix in TSV or Excel format. + +[⬅ Back to Study Configuration](../2-study.md) \ No newline at end of file diff --git a/docs/user-guide/study/areas/01-properties.md b/docs/user-guide/study/areas/01-properties.md index f5605ba153..5db1c5b2ec 100644 --- a/docs/user-guide/study/areas/01-properties.md +++ b/docs/user-guide/study/areas/01-properties.md @@ -1,7 +1,5 @@ # Area General Properties -[⬅ Area Configuration](../02-areas.md) - ## Introduction This documentation is dedicated to configuring the general properties of an area in the Antares Web application. @@ -18,6 +16,11 @@ To access the configuration of an area: ![01-properties-form.png](../../../assets/media/user-guide/study/areas/01-properties-form.png) -The area properties form allows you to configure the following elements: +The area properties form allows you to configure the following elements for each area of your study : + +- Energy cost +- Last resort shedding status +- Adequacy patch +- Output print status -> TODO +[⬅ Back to Area Configuration](../02-areas.md) diff --git a/docs/user-guide/study/areas/02-load.md b/docs/user-guide/study/areas/02-load.md index c2bf484dde..b1d7d06506 100644 --- a/docs/user-guide/study/areas/02-load.md +++ b/docs/user-guide/study/areas/02-load.md @@ -1,7 +1,5 @@ # Load Configuration -[⬅ Area Configuration](../02-areas.md) - ## Introduction This documentation is dedicated to configuring Load in the Antares Web application. @@ -24,12 +22,14 @@ and 1 column for each Monte-Carlo year. The available commands are: - **Assign a Matrix:** Search and assign a matrix from the matrix store to the load. -- **Import:** Drag and drop a TSV file to update the time series matrices. -- **Export:** Download the current TSV file using the "Export" button. +- **Import:** Drag and drop a TSV or CSV file to update the time series matrices. +- **Export:** Download the current TSV file using the "Export" button. You can also download this file in Excel format. You can edit a cell and confirm with the "Enter" key. You can also edit a group of cells or an entire column and confirm with the "Ctrl+Enter" key combination. -The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/latest/reference-guide/04-active_windows/#load). +The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/stable/user-guide/solver/02-inputs/#load). Explore these features to customize the ST Storage settings according to the specific needs of your study. + +[⬅ Back to Area Configuration](../02-areas.md) diff --git a/docs/user-guide/study/areas/03-thermals.md b/docs/user-guide/study/areas/03-thermals.md index 7e1d3f29ad..3b1467c879 100644 --- a/docs/user-guide/study/areas/03-thermals.md +++ b/docs/user-guide/study/areas/03-thermals.md @@ -1,7 +1,5 @@ # Thermal Clusters Configuration -[⬅ Area Configuration](../02-areas.md) - ## Introduction This documentation is dedicated to configuring Thermal Clusters (Thermals) in the Antares Web application. @@ -10,7 +8,7 @@ To access the configuration of Thermals: 1. From the "Study" view, click on the "MODELIZATION" tab. 2. Click on the "AREAS" tab, then choose an area from the sidebar. -3. Next, click on the "THERMALS" tab to access the page dedicated to Thermals. +3. Next, click on the "THERMAL" tab to access the page dedicated to Thermals. ![03-thermals.tab.png](../../../assets/media/user-guide/study/areas/03-thermals.tab.png) @@ -20,7 +18,7 @@ To access the configuration of Thermals: On the Thermals page, you will find the following elements: -- **Command Bar:** Add, duplicate, or delete thermal clusters using the "Add," "Duplicate," and "Delete" buttons. +- **Command Bar:** Add, duplicate, or delete thermal clusters using the "ADD," "DUPLICATE," and "DELETE" buttons. - **Toolbar:** Use the toolbar to filter and quickly search in the thermal clusters table. - **Selection and Actions:** Click on a row to select a thermal cluster. You can then delete or duplicate it. @@ -42,7 +40,7 @@ The **Total** row displays the sum of the values in the **Unit Count** and **Ena Click on the name of a thermal cluster to open the properties form. -![03-thermals.form.png](../../../assets/media/user-guide/study/areas/03-thermals.form.png) +![03-thermals.form.png](../../../assets/media/user-guide/study/areas/03-thermals-form.png) You will find the following elements: @@ -53,16 +51,23 @@ You will find the following elements: ## Time Series Matrices -In the tabs, you will find time series matrices composed of 8760 rows (hourly for a simulation year). +You will find at the bottom of the page differents tabs for matrix : +- COMMON : used to define the cluster's technico-economic characteristics +- TS GENERATOR : used to set the parameters of the stochastic generator +- AVAILABILITY : displays the "ready-made" 8760-hour time-series available for simulation purposes +- FUEL COSTS : used in case of TS Cost have the value "Use cost Timeseries" +- CO2 COSTS : used in case of TS Cost have the value "Use cost Timeseries" -![03-thermals.series.png](../../../assets/media/user-guide/study/areas/03-thermals.series.png) +![03-thermals.series.png](../../../assets/media/user-guide/study/areas/03-thermals-series.png) The available commands are: -- **Assign a Matrix:** Search and assign a matrix from the matrix store to Thermal Clusters. -- **Import:** Drag and drop a TSV file to update the time series matrices. -- **Export:** Download the current TSV file using the "Export" button. +- **IMPORT > From database:** Search and assign a matrix from the matrix store to Thermal Clusters. +- **IMPORT > From a file:** Drag and drop a TSV or CSV file to update the time series matrices. +- **Export:** Download the current TSV file using the "Export" button. You can also download the file in Excel format, choose this in the button dropdown list. You can edit a cell and confirm with the "Enter" key. You can also edit a group of cells or an entire column and confirm with the "Ctrl+Enter" key combination. -The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/latest/reference-guide/04-active_windows/#thermal). +The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/stable/user-guide/solver/02-inputs/#thermal). + +[⬅ Back to Area Configuration](../02-areas.md) \ No newline at end of file diff --git a/docs/user-guide/study/areas/04-renewables.md b/docs/user-guide/study/areas/04-renewables.md index f7298783c0..e079c7e719 100644 --- a/docs/user-guide/study/areas/04-renewables.md +++ b/docs/user-guide/study/areas/04-renewables.md @@ -1,7 +1,5 @@ # Renewable Clusters Configuration -[⬅ Area Configuration](../02-areas.md) - ## Introduction This documentation is dedicated to configuring Renewable Clusters (Renewables) in the Antares Web application. @@ -14,6 +12,12 @@ To access the configuration of Renewables: ![04-renewables.tab.png](../../../assets/media/user-guide/study/areas/04-renewables.tab.png) + +This tab is visible only when the study configuration have the value "Clusters" on Advanced parameters > Renewable generation modeling. + +![04-renewables-activation.png](../../../assets/media/user-guide/study/areas/04-renewables-activation.png) + + ## Renewable List ![04-renewables.list.png](../../../assets/media/user-guide/study/areas/04-renewables.list.png) @@ -58,10 +62,12 @@ In the tabs, you will find time series matrices composed of 8760 rows (hourly fo The available commands are: -- **Assign a Matrix:** Search and assign a matrix from the matrix store to Renewable Clusters. -- **Import:** Drag and drop a TSV file to update the time series matrices. -- **Export:** Download the current TSV file using the "Export" button. +- **IMPORT > From database:** Search and assign a matrix from the matrix store to Thermal Clusters. +- **IMPORT > From a file:** Drag and drop a TSV or CSV file to update the time series matrices. +- **Export:** Download the current TSV file using the "Export" button. You can also download the file in Excel format, choose this in the button dropdown list. You can edit a cell and confirm with the "Enter" key. You can also edit a group of cells or an entire column and confirm with the "Ctrl+Enter" key combination. -The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/latest/reference-guide/04-active_windows/#renewable). +The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/stable/user-guide/solver/02-inputs/#renewable). + +[⬅ Back to Area Configuration](../02-areas.md) \ No newline at end of file diff --git a/docs/user-guide/study/areas/05-hydro.md b/docs/user-guide/study/areas/05-hydro.md index c2a535bb2c..6e664584d0 100644 --- a/docs/user-guide/study/areas/05-hydro.md +++ b/docs/user-guide/study/areas/05-hydro.md @@ -1,6 +1,25 @@ +--- +title: Hydraulic Generators Configuration +author: Antares Web Team +date: 2024-11-22 +category: User Guide +tags: + + - hydraulic generators configuration + - hydro + - inflow structure + - allocation + - correlation + - daily power & energy credits + - reservoir levels + - water values + - hydro storage + - ROR run of river + - min gen + +--- # Hydraulic Generators Configuration - -[⬅ Area Configuration](../02-areas.md) +**_This section is under construction_** ## Introduction @@ -22,33 +41,27 @@ This tab allows you to configure the management options of the hydraulic generat ## Inflow Structure -This tab allows you to configure the inflow pattern time series and the overall monthly hydro parameters. +This tab allows you to configure the inter-monthly correlation, inflow pattern time series and the overall monthly hydro parameters. -> TODO +![05-hydro-inflowstructure.png](../../../assets/media/user-guide/study/areas/05-hydro-inflowstructure.png) ## Allocation This tab allows you to configure the allocation coefficients for each area. -> TODO +![05-hydro-allocation.png](../../../assets/media/user-guide/study/areas/05-hydro-allocation.png) ## Correlation This tab allows you to configure the correlation coefficients between the current area and the other areas. -> TODO - -## Daily Power +![05-hydro-correlation.png](../../../assets/media/user-guide/study/areas/05-hydro-correlation.png) -This tab allows you to configure the daily generating power and the pumping power of the hydraulic generators. +## Daily Power & Energy Credits -> TODO - -## Energy Credits +This tab allows you to configure the daily generating power and the pumping power of the hydraulic generators, the energy credits time series of the hydraulic generators. -This tab allows you to configure the energy credits time series of the hydraulic generators. - -> TODO +![05-hydro-dailypower-energycredits.png](../../../assets/media/user-guide/study/areas/05-hydro-dailypower-energycredits.png) ## Reservoir Levels @@ -76,4 +89,6 @@ This tab allows you to configure the run of river time series of the hydraulic g The "Min Gen." tab is dedicated to configuring the minimum generation levels of the hydraulic generators. This tab presents a time series that represents the minimum hourly production for one or more Monte-Carlo years. -![05-hydro.min-generation.series.png](../../../assets/media/user-guide/study/areas/05-hydro.min-generation.series.png) \ No newline at end of file +![05-hydro.min-generation.series.png](../../../assets/media/user-guide/study/areas/05-hydro.min-generation.series.png) + +[⬅ Back to Area Configuration](../02-areas.md) \ No newline at end of file diff --git a/docs/user-guide/study/areas/06-wind.md b/docs/user-guide/study/areas/06-wind.md index 176ea212de..884bfcdcb0 100644 --- a/docs/user-guide/study/areas/06-wind.md +++ b/docs/user-guide/study/areas/06-wind.md @@ -13,3 +13,9 @@ To access the configuration of Wind: 3. Next, click on the "WIND" tab to access the page dedicated to wind generators. ![06-wind.tab.png](../../../assets/media/user-guide/study/areas/06-wind.tab.png) + +You will see here 8760-hour time-series already available for simulation purposes. You can update this data. + +This tab is visible only when the study configuration have the value "Aggregated" on Advanced parameters > Renewable generation modeling. + +![06-wind-activation.png](../../../assets/media/user-guide/study/areas/06-wind-activation.png) diff --git a/docs/user-guide/study/areas/08-st-storages.md b/docs/user-guide/study/areas/08-st-storages.md index 11f1135a74..881dd9ebfc 100644 --- a/docs/user-guide/study/areas/08-st-storages.md +++ b/docs/user-guide/study/areas/08-st-storages.md @@ -1,7 +1,18 @@ +--- +title: Short-Term Storage Configuration +author: Antares Web Team +date: 2024-11-22 +category: User Guide +tags: + + - short-term storage configuration + - injection capacity + - withdrawal capacity + - stock + +--- # Short-Term Storage Configuration -[⬅ Area Configuration](../02-areas.md) - ## Introduction This documentation is dedicated to configuring short-term storage (ST Storage) in the Antares Web application. @@ -17,7 +28,11 @@ To access the configuration of ST storages: ## ST Storage List -![08-st-storages.list.png](../../../assets/media/user-guide/study/areas/08-st-storages.list.png) +![08-st-storages-list.png](../../../assets/media/user-guide/study/areas/08-st-storage-list.png) +_Screenshot for a study version under 8.8_ + +![08-st-storages-list-enable.png](../../../assets/media/user-guide/study/areas/08-st-storage-list-enable.png) +_Screenshot for a study version in 8.8_ On the ST storages page, you will find the following elements: @@ -29,21 +44,26 @@ The storages table displays the following information: - **Group:** Name of the group to which the storage belongs. - **Name:** Name of the storage (link to the properties form). -- **Withdrawal (MW):** Withdrawal power of the storage. -- **Injection (MW):** Injection power of the storage. -- **Reservoir (MWh):** Reservoir capacity of the storage. +- **Enabled:** Indicates whether the storage is enable or disable. Only from version 8.8 of studies. +- **Stored (MW):** Withdrawal power of the storage. +- **Released (MW):** Injection power of the storage. +- **Stock (MWh):** Reservoir capacity of the storage. - **Efficiency (%):** Efficiency of the storage. - **Initial Level (%):** Initial level of the storage. - **Initial Level Optimized:** Indicates whether the initial level of the storage is optimized. -The **Total** row displays the sum of the values in the **Withdrawal** and **Injection** columns. +The **Total** row displays the sum of the values in the **Stored** and **Released** columns. +### New update +From version 8.8 of the studies, a new parameter has been added to the short-term storage objects. This is an option that allows you to enable/disable storage. +Note that this option is not valid for studies lower than version 8.8. To be able to use it, you must update your study to at least version 8.8. ## Configuration Form Click on the name of a storage to open the properties form. -![08-st-storages.form.png](../../../assets/media/user-guide/study/areas/08-st-storages.form.png) +![08-st-storages-form.png](../../../assets/media/user-guide/study/areas/08-st-storages-form.png) +_Screenshot for a study version under 8.8_ You will find the following elements: @@ -51,20 +71,20 @@ You will find the following elements: - Modify the values and click "Save" to confirm the changes. - Use the "↶" buttons to undo changes and "↷" to redo them, confirm the modification with "Save." -The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/latest/reference-guide/13-file-format/#short-term-storage_1). - ## Time Series Matrices In the tabs, you will find time series matrices composed of 8760 rows (hourly for a simulation year). -![08-st-storages.series.png](../../../assets/media/user-guide/study/areas/08-st-storages.series.png) +![08-st-storages-series.png](../../../assets/media/user-guide/study/areas/08-st-storages-series.png) The available commands are: -- **Assign a Matrix:** Search and assign a matrix from the matrix store to short-term storage. -- **Import:** Drag and drop a TSV file to update the time series matrices. -- **Export:** Download the current TSV file using the "Export" button. +- **IMPORT > From database:** Search and assign a matrix from the matrix store to Thermal Clusters. +- **IMPORT > From a file:** Drag and drop a TSV or CSV file to update the time series matrices. +- **Export:** Download the current TSV file using the "Export" button. You can also download the file in Excel format, choose this in the button dropdown list. You can edit a cell and confirm with the "Enter" key. You can also edit a group of cells or an entire column and confirm with the "Ctrl+Enter" key combination. -The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/latest/reference-guide/13-file-format/#short-term-storage_1). +The detailed configuration is available in the [Antares Simulator documentation](https://antares-simulator.readthedocs.io/en/stable/user-guide/solver/02-inputs/#storages). + +[⬅ Back to Area Configuration](../02-areas.md) diff --git a/mkdocs.yml b/mkdocs.yml index 5a28ea96df..02bd594987 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,12 +32,11 @@ nav: - 'User guide': - 'Introduction': 'user-guide/0-introduction.md' - 'User interface': 'user-guide/1-interface.md' - - 'Study Configuration': - - 'Main Topics': 'user-guide/2-study.md' - - 'Map': - - 'Main Topics': 'user-guide/study/01-map.md' + - 'Study Modelization': + - 'Overview': 'user-guide/2-study.md' + - 'Map': 'user-guide/study/01-map.md' - 'Area Configuration': - - 'Main Topics': 'user-guide/study/02-areas.md' + - 'Overview': 'user-guide/study/02-areas.md' - 'General Properties': 'user-guide/study/areas/01-properties.md' - 'Load': 'user-guide/study/areas/02-load.md' - 'Thermal Clusters': 'user-guide/study/areas/03-thermals.md' @@ -48,30 +47,41 @@ nav: - 'Short-Term Storages': 'user-guide/study/areas/08-st-storages.md' - 'Reserves': 'user-guide/study/areas/09-reserves.md' - 'Miscellaneous Generators': 'user-guide/study/areas/10-misc-gen.md' - - 'Links': - - 'Main Topics': 'user-guide/study/03-links.md' - - 'Binding Constraints': - - 'Main Topics': 'user-guide/study/04-binding-constraints.md' - - 'Debug': - - 'Main Topics': 'user-guide/study/05-debug.md' - - 'Table Mode': - - 'Main Topics': 'user-guide/study/06-table-mode.md' + - 'Links': 'user-guide/study/03-links.md' + - 'Binding Constraints': 'user-guide/study/04-binding-constraints.md' + - 'Simulation Configuration': + 'General Configuration': 'user-guide/simulation-configuration/all-configurations.md#general-configuration' + 'TS management': 'user-guide/simulation-configuration/all-configurations.md#Time-series management' + 'Optimization preferences': 'user-guide/simulation-configuration/all-configurations.md#optimization-preferences' + 'Adequacy Patch': 'user-guide/simulation-configuration/all-configurations.md#adequacy-patch' + 'Advanced parameters': 'user-guide/simulation-configuration/all-configurations.md#advanced-parameters' + 'Economic Opt.': 'user-guide/simulation-configuration/all-configurations.md#economic-opt' + 'Geographic Trimming (Areas)': 'user-guide/simulation-configuration/all-configurations.md#geographic-trimming(areas)' + 'Geographic Trimming (Links)': 'user-guide/simulation-configuration/all-configurations.md#geographic-trimming(links)' + 'Geographic Trimming (Binding Constraints)': 'user-guide/simulation-configuration/all-configurations.md#geographic-trimming(binding-constrainte)' + - 'Table Mode': 'user-guide/study/06-table-mode.md' + - 'Xpansion' : user-guide/study/07-xpansion.md + - 'Results' : user-guide/study/08-results.md + - 'Debug': 'user-guide/study/05-debug.md' - 'Variant manager': 'user-guide/3-variant_manager.md' - - 'How to': - - 'Create a study': 'how-to/studies-create.md' - - 'Import a study': 'how-to/studies-import.md' - - 'Upgrade a study': 'how-to/studies-upgrade.md' - - 'Build': - - 'Introduction': 'install/0-INSTALL.md' - - 'Configuration': 'install/1-CONFIG.md' - - 'Deployment': 'install/2-DEPLOY.md' - - 'Develop': - - 'Introduction': 'architecture/0-introduction.md' - - 'Database management': 'architecture/1-database.md' - - 'Add a new Study version': 'architecture/2-add-new-antares-version.md' - - 'Roadmap': 'architecture/5-roadmap.md' - - 'Antares ecosystem': 'https://antares-doc.readthedocs.io' - - 'Changelog': 'CHANGELOG.md' + - 'How to': + - 'Create a study': 'user-guide/how-to/studies-create.md' + - 'Import a study': 'user-guide/how-to/studies-import.md' + - 'Upgrade a study': 'user-guide/how-to/studies-upgrade.md' + - 'Developer guide': + - 'Build': + - 'Introduction': 'developer-guide/install/0-INSTALL.md' + - 'Configuration': 'developer-guide/install/1-CONFIG.md' + - 'Deployment': 'developer-guide/install/2-DEPLOY.md' + - 'Architecture': 'developer-guide/architecture/0-introduction.md' + - 'Database management': 'developer-guide/architecture/1-database.md' + - 'Add a new study version': 'developer-guide/2-add-new-antares-version.md' + - 'Changelog': 'CHANGELOG.md' + - 'Roadmap': 'developer-guide/5-roadmap.md' + - 'External links' : + - 'Antares ecosystem': 'https://antares-doc.readthedocs.io' + - 'Antares website' : 'https://antares-simulator.org/' + - 'RTE website' : 'http://www.rte-france.com/' extra: generator: false @@ -101,4 +111,4 @@ markdown_extensions: - pymdownx.superfences - pymdownx.tabbed -copyright: Copyright © 2007 - 2023 RTE \ No newline at end of file +copyright: Copyright © 2007 - 2024 RTE \ No newline at end of file