docs: improve of the documentary tree and make some update (#2243)

AntaresSimulatorTeam · Nov 28, 2024 · 2711e0b · 2711e0b
1 parent 45e356a
commit 2711e0b
Show file tree

Hide file tree

Showing 75 changed files with 408 additions and 137 deletions.
diff --git a/docs/architecture/5-roadmap.md b/docs/architecture/5-roadmap.md
diff --git a/docs/assets/media/img/installer_screenshot.png b/docs/assets/media/img/installer_screenshot.png
diff --git a/docs/assets/media/img/userguide_change_language.png b/docs/assets/media/img/userguide_change_language.png
diff --git a/docs/assets/media/img/userguide_token_creation.png b/docs/assets/media/img/userguide_token_creation.png
diff --git a/docs/assets/media/img/userguide_token_listing.png b/docs/assets/media/img/userguide_token_listing.png
diff --git a/docs/assets/media/img/userguide_token_result.png b/docs/assets/media/img/userguide_token_result.png
diff --git a/...sets/media/user-guide/simulation-configuration/01-configuration-general-tab.png b/...sets/media/user-guide/simulation-configuration/01-configuration-general-tab.png
diff --git a/...guide/simulation-configuration/01-configuration-general-themmatic-trimming1.png b/...guide/simulation-configuration/01-configuration-general-themmatic-trimming1.png
diff --git a/...guide/simulation-configuration/01-configuration-general-themmatic-trimming2.png b/...guide/simulation-configuration/01-configuration-general-themmatic-trimming2.png
diff --git a/...user-guide/simulation-configuration/02-configuration-timeseries-management1.png b/...user-guide/simulation-configuration/02-configuration-timeseries-management1.png
diff --git a/...user-guide/simulation-configuration/02-configuration-timeseries-management2.png b/...user-guide/simulation-configuration/02-configuration-timeseries-management2.png
diff --git a/docs/assets/media/user-guide/study/01-map-tab.png b/docs/assets/media/user-guide/study/01-map-tab.png
diff --git a/docs/assets/media/user-guide/study/01-map.tab.png b/docs/assets/media/user-guide/study/01-map.tab.png
diff --git a/docs/assets/media/user-guide/study/02-areas-tab.png b/docs/assets/media/user-guide/study/02-areas-tab.png
diff --git a/docs/assets/media/user-guide/study/02-areas.tab.png b/docs/assets/media/user-guide/study/02-areas.tab.png
diff --git a/docs/assets/media/user-guide/study/03-links-tab.png b/docs/assets/media/user-guide/study/03-links-tab.png
diff --git a/docs/assets/media/user-guide/study/03-links.tab.png b/docs/assets/media/user-guide/study/03-links.tab.png
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
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
diff --git a/docs/assets/media/user-guide/study/05-debug-tab.png b/docs/assets/media/user-guide/study/05-debug-tab.png
diff --git a/docs/assets/media/user-guide/study/05-debug.tab.png b/docs/assets/media/user-guide/study/05-debug.tab.png
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
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
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
diff --git a/docs/assets/media/user-guide/study/08-layers-districts.png b/docs/assets/media/user-guide/study/08-layers-districts.png
diff --git a/docs/assets/media/user-guide/study/09-results-view.png b/docs/assets/media/user-guide/study/09-results-view.png
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
diff --git a/...architecture/2-add-new-antares-version.md → ...eloper-guide/2-add-new-antares-version.md b/...architecture/2-add-new-antares-version.md → ...eloper-guide/2-add-new-antares-version.md
diff --git a/docs/developer-guide/5-roadmap.md b/docs/developer-guide/5-roadmap.md
@@ -0,0 +1,2 @@
+# Roadmap
+**_This section is under construction_**
diff --git a/docs/architecture/0-introduction.md → ...oper-guide/architecture/0-introduction.md b/docs/architecture/0-introduction.md → ...oper-guide/architecture/0-introduction.md
diff --git a/docs/architecture/1-database.md → ...eveloper-guide/architecture/1-database.md b/docs/architecture/1-database.md → ...eveloper-guide/architecture/1-database.md
diff --git a/docs/install/0-INSTALL.md → docs/developer-guide/install/0-INSTALL.md b/docs/install/0-INSTALL.md → docs/developer-guide/install/0-INSTALL.md
diff --git a/docs/install/1-CONFIG.md → docs/developer-guide/install/1-CONFIG.md b/docs/install/1-CONFIG.md → docs/developer-guide/install/1-CONFIG.md
diff --git a/docs/install/2-DEPLOY.md → docs/developer-guide/install/2-DEPLOY.md b/docs/install/2-DEPLOY.md → 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
@@ -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
@@ -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
@@ -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
@@ -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 → docs/user-guide/how-to/studies-create.md b/docs/how-to/studies-create.md → 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 → docs/user-guide/how-to/studies-import.md b/docs/how-to/studies-import.md → docs/user-guide/how-to/studies-import.md
diff --git a/docs/how-to/studies-upgrade.md → docs/user-guide/how-to/studies-upgrade.md b/docs/how-to/studies-upgrade.md → 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
@@ -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
@@ -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)
diff --git a/docs/user-guide/study/02-areas.md b/docs/user-guide/study/02-areas.md
@@ -1,15 +1,13 @@
 # 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:
 
 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
@@ -1,13 +1,13 @@
 # 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:
 
 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)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Roadmap
		_This section is under construction_