From f121d428d6b53b63aab29c510d36a3ff4d3d0b7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jason=20Mar=C3=A9chal?= <45510813+JasonMarechal25@users.noreply.github.com> Date: Fri, 22 Mar 2024 15:27:35 +0100 Subject: [PATCH] Add high level design information (#757) --- conception/README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 conception/README.md diff --git a/conception/README.md b/conception/README.md new file mode 100644 index 000000000..f1cdde384 --- /dev/null +++ b/conception/README.md @@ -0,0 +1,44 @@ +# Xpansion design informations + +## Domains + +Xpansion aims at performing investment simulations for Antares studies. This means that the core domain of xpansion +could +be described as : **investment simulations for Antares studies** +This core domain is composed of subdomains: + +- Investment strategy: how to describe the investment strategy based on an Antares Simulation +- Linear optimization problem-solving + +## Mapping design with domains + +| Domain | Component | Details | +|--------------------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Investment simulations for Antares studies | Xpansion as a whole | | +| Investment strategy | Problem Generation | Investment strategy is defined by candidates. Those candidates are used to enrich an Antares study simulation. It produces a linear optimization problem | +| Linear optimization problem-solv ing | Benders | Benders solve optimization problems. It is agnostic of the "business" of the core domain. Mathematical outputs need to be translated as business values in other components | + +## Conception folder + +In the conception folder you will find design documentation. + +### Architecture decision records + +Also called ADR. A list of design decisions with date, status and motivation. This allows going back to ADR to +understand +why choices have been made. Choices are not irrevocable, they can be deprecated in favor of new choices. The goal of +ADRs +is exactly to follow the evolution of these choices. + +### C4 + +Various C4 diagrams following [C4 model conventions](https://c4model.com/) + +### SequenceDiagrams + +Various sequence diagrams to help understand the flow of the application + +### SimulationOutputs + +Various example of simulation outputs +