Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Archived] Feature/memory patch #487

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
uc_type = expansion_fast
master = integer
optimality_gap = 10000
optimality_gap = 100

19 changes: 19 additions & 0 deletions data_test/unit_tests/master.mps
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
NAME master
ROWS
N OBJ
L C1
L C2
COLUMNS
x1 OBJ -5.0
x1 C1 1.0
x1 C2 10.0
x2 OBJ -4.0
x2 C1 1.0
x2 C2 6.0
RHS
RHS C1 5.0
RHS C2 45.0
BOUNDS
LO BND x1 0.0
LO BND x2 0.0
ENDATA
19 changes: 19 additions & 0 deletions data_test/unit_tests/subproblem.mps
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
NAME subproblem
ROWS
N OBJ
L C1
L C2
COLUMNS
x1 OBJ -5.0
x1 C1 1.0
x1 C2 10.0
x2 OBJ -4.0
x2 C1 1.0
x2 C2 6.0
RHS
RHS C1 5.0
RHS C2 45.0
BOUNDS
LO BND x1 0.0
LO BND x2 0.0
ENDATA
25 changes: 16 additions & 9 deletions docs/user-guide/get-started/launching-optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Default value: `full`.
The execution of Antares-Xpansion consists of several steps that can be run separately. The
`--step` parameter allows to select the steps to execute:

| Step | Description |
| :-------- | ------------------------------------------------------------------------ |
| `antares` | Launch Antares-Simulator once to get the Antares problem.
| `problem_generation` | Generate the full Antares-Xpansion problem using the user input and the output of the Antares-Simulator run. |
| `benders` | Solve the investment optimization problem of Antares-Xpansion, using the [Benders decomposition](../optimization-principles/investment-problem.md).|
| `study_update` | Update the Antares study with the solution returned by the [Benders decomposition](../optimization-principles/investment-problem.md) algorithm. |
| `full` | Launch all steps in order: `antares` \> `problem_generation` \> `benders` \> `study_update` |
| `sensitivity` | Launch sensitivity analysis, see [Sensitivity analysis](sensitivity-analysis.md). |
| `resume` | resume benders step of a study in accordance with `--simulationName`, by default `last` study is resumed. |
| Step | Description |
|:-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `antares` | Launch Antares-Simulator once to get the Antares problem.
| `problem_generation` | Generate the full Antares-Xpansion problem using the user input and the output of the Antares-Simulator run. |
| `benders` | Solve the investment optimization problem of Antares-Xpansion, using the [Benders decomposition](../optimization-principles/investment-problem.md). |
| `study_update` | Update the Antares study with the solution returned by the [Benders decomposition](../optimization-principles/investment-problem.md) algorithm. |
| `full` | Launch all steps in order: `antares` \> `problem_generation` \> `benders` \> `study_update` |
| `sensitivity` | Launch sensitivity analysis, see [Sensitivity analysis](sensitivity-analysis.md). |
| `resume` | resume benders step of a study in accordance with `--simulationName`, by default `last` study is resumed. |

#### `-i, --dataDir`

Expand Down Expand Up @@ -91,6 +91,13 @@ Show the Antares-Xpansion version.

Show the Antares-Simulator version (used in the `antares` step).

### `--construct_all_problems`

Default value: `True`.


`{True|False}`. Define if you want the benders step to construct all problems initially (True) or to rebuild them each iteration (False). Set to False to reduce maximum RAM usage at the cost of longer execution time (e.g. Running a large study on a personal computer.)

## Graphical user interface

Since v0.6.0, Antares-Xpansion comes with a GUI. The GUI can be launched by running `antares-xpansion-ui.exe`. For now, this GUI is in the experimental phase.
Expand Down
1 change: 1 addition & 0 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ if (PYINSTALLER)
endif()

if (BUILD_UI)
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/python/config.yaml DESTINATION . )
install(CODE "execute_process(COMMAND ${PYINSTALLER} -F ${CMAKE_CURRENT_SOURCE_DIR}/python/antares-xpansion-ui.py -n antares-xpansion-ui)" )
endif()

Expand Down
Loading