Skip to content

Commit

Permalink
Merge branch 'develop' into feature/new_quad_solvers
Browse files Browse the repository at this point in the history
  • Loading branch information
pet-mit committed Feb 17, 2025
2 parents 1453583 + aff8942 commit dc7e060
Show file tree
Hide file tree
Showing 35 changed files with 705 additions and 204 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ root of the project and running:
cd docs/pdf-doc-generation-with-sphinx
bash create_pdf_doc.sh user-guide.pdf
```
(You'll have to install these dependencies first: latexmk texlive-latex-recommended texlive-formats-extra).
Sphinx will create a `user-guide.pdf` file in `docs/pdf-doc-generation-with-sphinx`.

### Doxygen
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/3-Build.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ Here is a list of mandatory or optional CMake configuration options:
| `CMAKE_TOOLCHAIN_FILE` | no | Path to VCPKG toolchain file, allows to integrate VCPKG with cmake build | `../vcpkg/scripts/buildsystems/vcpkg.cmake` | |
| `VCPKG_TARGET_TRIPLET` | no | Define VCPKG triplet (build type for dependencies etc.) | `x64-windows-antares` / `x64-linux-antares` | |

> 💡 **Disable the UI build to make builds faster**
> 💡 **Disable the UI build to make builds faster**
> The UI takes up a good chunk of compilation time. It is enabled by default, but you can disable it by turning off `BUILD_UI`
> 💡 **Use Ninja to speed up target generation by CMake**
> 💡 **Use Ninja to speed up target generation by CMake**
> At configure time, you may specify Ninja for generation instead of traditional Make. This will speed up the update
> step after you make small changes to the code.
> ```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Dynamic modeler architecture

## Models
(for details about these concepts, see [this page](../../user-guide/solver/dynamic-modeler/05-model.md))
(for details about these concepts, see [this page](../../user-guide/modeler/05-model.md))

```plantuml
@startuml
Expand Down Expand Up @@ -85,7 +85,7 @@ ModelLibraryRepository "1" *-- "0:N" ModelLibrary
```

## Components
(for details about these concepts, see [this page](../../user-guide/solver/dynamic-modeler/05-model.md))
(for details about these concepts, see [this page](../../user-guide/modeler/05-model.md))

```plantuml
@startuml
Expand Down
3 changes: 2 additions & 1 deletion docs/user-guide/00-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
02-install.md
03-getting_started.md
solver/00-index.md
ts-analyzer-generator/00-index.md
modeler/00-index.md
ts-generator/00-index.md
other-features/00-index.md
04-migration-guides.md
05-attribution-notices.md
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/01-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ the random factors that may affect the balance between load and generation. Econ
as much a critical role as they do in the other kinds of studies since the stakes are mainly to know if and
when supply security is likely to be jeopardized (detailed costs incurred in more ordinary conditions are of
comparatively lower importance). In these studies, the default *Antares* option to use is the
[`adequacy`](solver/static-modeler/04-parameters.md#mode) simulation mode.
[`adequacy`](solver/04-parameters.md#mode) simulation mode.

### Transmission project profitability
[//]: # (TODO: explain what "fair and perfect market" means)
Expand All @@ -45,7 +45,7 @@ and/or improvement of the security of supply (reduction of the loss-of-load expe
In these studies, economic parameters and the physical modeling of the dynamic constraints bearing on
the generating units are of paramount importance. Though a thorough survey of many "Monte-Carlo years"
is still required, the number of scenarios to simulate is not as large as in generation adequacy studies.
In these studies, the default *Antares* option to use is the [`economy`](solver/static-modeler/04-parameters.md#mode) simulation mode.
In these studies, the default *Antares* option to use is the [`economy`](solver/04-parameters.md#mode) simulation mode.

## Performance considerations
Typically, *Antares* has to solve a least-cost hydro-thermal power schedule and unit commitment problem, with an hourly
Expand All @@ -54,7 +54,7 @@ The large number and the size of the individual problems to solve often make opt

Depending on user-defined results accuracy requirements, various practical options[^2] allow to simplify either
the formulation of the problems, or their resolution.
[^2]: See [hydro-pricing-mode](solver/static-modeler/04-parameters.md#hydro-pricing-mode), [unit-commitment-mode](solver/static-modeler/04-parameters.md#unit-commitment-mode)
[^2]: See [hydro-pricing-mode](solver/04-parameters.md#hydro-pricing-mode), [unit-commitment-mode](solver/04-parameters.md#unit-commitment-mode)

[//]: # (TODO: list in [^2] the other parameters that have impact on performance)

Expand All @@ -73,4 +73,4 @@ operation problems (one for each week of each Monte-Carlo year), assumed to be i
Note that, however, dependency issues such as the management of hydro stock (or any other kind of energy storage
facility) may bring a significant coupling between the successive problems, which needs to be addressed properly[^3].

[^3]: See how *Antares* addresses stock dependency between successive problems [here](solver/static-modeler/06-hydro-heuristics.md#seasonal-hydro-pre-allocation).
[^3]: See how *Antares* addresses stock dependency between successive problems [here](solver/06-hydro-heuristics.md#seasonal-hydro-pre-allocation).
10 changes: 5 additions & 5 deletions docs/user-guide/02-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Installed alone, the Antares simulator does not require a lot of HDD space (less
- The number of ready-made Time-Series and the number of Time-Series to be generated at runtime and stored afterward
(see [these parameters](ts-generator/04-parameters.md#time-series-parameters)).
- The activation of output filters
(see [thematic-trimming](solver/static-modeler/04-parameters.md#thematic-trimming) and [geographic-trimming](solver/static-modeler/04-parameters.md#geographic-trimming) parameters).
(see [thematic-trimming](solver/04-parameters.md#thematic-trimming) and [geographic-trimming](solver/04-parameters.md#geographic-trimming) parameters).
- The number of Monte-Carlo years involved in the simulation session, if the storage of detailed
[year-by-year results](solver/static-modeler/04-parameters.md#year-by-year) is activated
- Whether [MPS export](solver/static-modeler/04-parameters.md#include-exportmps) is activated
[year-by-year results](solver/04-parameters.md#year-by-year) is activated
- Whether [MPS export](solver/04-parameters.md#include-exportmps) is activated

If you encounter space issues, consider tweaking the aforementioned parameters or reducing your study size.

Expand All @@ -35,8 +35,8 @@ The amount of RAM required for a simulation depends on:

- The size of the power system model (number of Areas, Links, Thermal clusters, etc.)
- The number of ready-made Time-Series and that of Time-Series to be generated at runtime
- The simulation [mode](solver/static-modeler/04-parameters.md#mode)
- The [unit commitment resolution mode](solver/static-modeler/04-parameters.md#unit-commitment-mode)
- The simulation [mode](solver/04-parameters.md#mode)
- The [unit commitment resolution mode](solver/04-parameters.md#unit-commitment-mode)
- If the [multi-threading](solver/optional-features/multi-threading.md) option is used

If you encounter memory issues, consider tweaking the aforementioned parameters or reducing your study size.
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/03-getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,16 @@ These steps most often involve:

1. Initializing or updating the input data (time-series, grid topology, fleet description, etc.).
*In this step, the user is expected to provide all the input data they have, except the time-series that are
supposed to be [automatically generated](solver/static-modeler/04-parameters.md#generate) by *Antares* (see step (3)).*
supposed to be [automatically generated](solver/04-parameters.md#generate) by *Antares* (see step (3)).*
*As stated above, it is highly recommended to use robust tools to produce input data, such as [Antares Web](https://antares-web.readthedocs.io)
or [Antares Extensions](#using-extensions).*
2. Defining the simulation contexts (definition of the "Monte-Carlo years" to simulate)
3. *(Optional)* If some time-series are supposed to be [automatically generated](solver/static-modeler/04-parameters.md#generate),
3. *(Optional)* If some time-series are supposed to be [automatically generated](solver/04-parameters.md#generate),
running a simulation to produce actual numeric scenarios, following the directives defined in (2).
*In this step, the [ts-generator](ts-generator/01-overview-tsgenerator.md) tool should be used.*
4. Running the optimization, to solve all the optimization problems associated with each of the scenarios produced in (3).
*In this step, the main [solver](solver/01-overview-solver.md) tool should be used.*
5. Exploiting the detailed [results](solver/static-modeler/03-outputs.md) yielded by (4).
5. Exploiting the detailed [results](solver/03-outputs.md) yielded by (4).
*In this step, we recommend using [Antares Web](https://antares-web.readthedocs.io)
or [Antares Extensions](#using-extensions).*

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
[//]: # (Index used by Sphinx to generate correct PDF tree)

# Dynamic Modeler
# Modeler

```{toctree}
:hidden:
01-overview-new-solver.md
01-overview-modeler.md
02-inputs.md
03-outputs.md
04-parameters.md
05-model.md
06-heuristics.md
07-standard-library.md
08-hybrid-studies.md
09-command-line.md
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

_**Disclaimer: please note that the new Antares dynamic modeler is still under development, and that some of the
_**Disclaimer: please note that the new Antares modeler is still under development, and that some of the
features described in this section may still be unavailable**_

The new Antares dynamic modeler allows more flexibility in the definition of physical models used in the simulation.
Expand Down
Loading

0 comments on commit dc7e060

Please sign in to comment.