diff --git a/docs/developer-guide/2-Dependencies-install.md b/docs/developer-guide/2-Dependencies-install.md index 1177228e6a..6fec5520da 100644 --- a/docs/developer-guide/2-Dependencies-install.md +++ b/docs/developer-guide/2-Dependencies-install.md @@ -8,29 +8,27 @@ toc_depth: 2 - [Sirius Solver](https://github.com/AntaresSimulatorTeam/sirius-solver/tree/Antares_VCPKG) (fork from [RTE](https://github.com/rte-france/sirius-solver/tree/Antares_VCPKG)) - [OR-Tools](https://github.com/rte-france.com/or-tools) (fork from [Google](https://github.com/google/or-tools)) -- [wxWidgets](https://github.com/wxWidgets/wxWidgets) (Only for the complete Antares Simulator solution with GUI) - [minizip](https://github.com/zlib-ng/minizip-ng) library, with its dependency zlib - [Boost](https://www.boost.org/) libraries: header libraries and boost-test library -- [libuuid](https://linux.die.net/man/3/libuuid) on Linux systems We favor using [vcpkg](https://github.com/microsoft/vcpkg) for building and installing most of those dependencies, see [build instructions](3-Build.md) which explain how it integrates with CMake build. However, we still have a few exceptions that must be installed in a different way, see next sections. -Although not encouraged, it's still possible to install those dependencies yourself and add +Although not encouraged, it's still possible to install those dependencies yourself and add their installation path to your `CMAKE_PREFIX_PATH`. ## OR-Tools OR-Tools may be installed in one of 2 ways: -1. **As a pre-compiled dependency** +1. **As a pre-compiled dependency** You can [download](https://github.com/rte-france/or-tools/releases) a precompiled OR-Tools archive that contains headers & static libraries. - + Please note that dynamic linking with OR-Tools is only supported in Linux. - + Decompress the archive, and provide its path as a `CMAKE_PREFIX_PATH`. 2. **As part of the build** @@ -40,31 +38,3 @@ OR-Tools may be installed in one of 2 ways: The drawback of this second approach is that OR-Tools may need to be built again when you run again a cmake configure step, therefore it's not advised for developers. - - -## Linux: libuuid and wxWidgets - -On Linux systems, libuuid development packages need to be installed with your -OS package manager. -You will also need to install wxWidgets if you want to build the GUI. - -=== "Centos" - - ``` - sudo yum install libuuid-devel - sudo yum install wxGTK3-devel - ``` - -=== "Ubuntu 20.04 or 22.04 / Debian 11" - - ``` - sudo apt install uuid-dev - sudo apt install libwxgtk3.0-gtk3-dev - ``` - -=== "Ubuntu 23.04 / Debian 12" - - ``` - sudo apt install uuid-dev - sudo apt install libwxgtk3.2-dev - ``` diff --git a/docs/developer-guide/3-Build.md b/docs/developer-guide/3-Build.md index 860c9f47cb..da65327e10 100644 --- a/docs/developer-guide/3-Build.md +++ b/docs/developer-guide/3-Build.md @@ -4,7 +4,7 @@ Before building, make sure that dependencies are [installed](2-Dependencies-inst ## Install VCPKG -Although you may install third party dependencies yourself, the preferred way is +Although you may install third party dependencies yourself, the preferred way is to rely on [vcpkg](https://github.com/microsoft/vcpkg) and its CMake integration to build and install most of them. @@ -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. > ``` @@ -96,15 +96,13 @@ Here is a list of mandatory or optional CMake configuration options: ``` > 💡 Compilation can be done on several processors with `-j` option. - -The final GUI file can be executed at `_build/ui/simulator/antares-X.Y-ui-simulator` ## Developer tips -### Use a compiler cache +### Use a compiler cache In order to avoid unnecessary rebuilds, for example when you switch branches, you may use a compiler cache -such as ccache. Using it under Linux systems is pretty easy with CMake, you only need to specify it +such as ccache. Using it under Linux systems is pretty easy with CMake, you only need to specify it as the compiler launcher at configure time: ``` cmake ... -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache ... @@ -119,5 +117,4 @@ This way git won't waste time computing diff on these when checking out, diffing Keep in mind that your submodules won't be updated. - -[^1]: GUI support has been dropped in favor of [Antares Web](https://antares-web.readthedocs.io) \ No newline at end of file +[^1]: GUI support has been dropped in favor of [Antares Web](https://antares-web.readthedocs.io) diff --git a/docs/developer-guide/5-Installer-creation.md b/docs/developer-guide/5-Installer-creation.md index 459dac39f8..11fcd3350c 100644 --- a/docs/developer-guide/5-Installer-creation.md +++ b/docs/developer-guide/5-Installer-creation.md @@ -29,12 +29,11 @@ CPack can be used to create the installer after the build phase: cd _build cpack3 -G TGZ ``` - + ### Required system libraries - There are still some system libraries that must be installed if you want to use *Antares Simulator*: + There are still some system libraries that must be installed if you want to use *Antares Simulator*: ``` sudo yum install epel-release - sudo yum install wxGTK3 ``` === "Ubuntu/Debian" @@ -49,9 +48,3 @@ CPack can be used to create the installer after the build phase: cd _build cpack -G TGZ ``` - - ### Required system libraries - There are still some system libraries that must be installed if you want to use *Antares Simulator*: - ``` - sudo apt install libwxgtk3.0-gtk3-0v5 - ``` diff --git a/docs/ref_guides/system-map-editor-reference-guide.pdf b/docs/ref_guides/system-map-editor-reference-guide.pdf deleted file mode 100644 index fc34bca004..0000000000 Binary files a/docs/ref_guides/system-map-editor-reference-guide.pdf and /dev/null differ diff --git a/docs/user-guide/05-attribution_notices.md b/docs/user-guide/05-attribution_notices.md index 082f56c490..419999db51 100644 --- a/docs/user-guide/05-attribution_notices.md +++ b/docs/user-guide/05-attribution_notices.md @@ -21,10 +21,6 @@ If not, see [https://opensource.org/license/mpl-2-0/](https://opensource.org/lic **Antares\_Simulator 8.3 uses external libraries and makes extensive use of the following persons' or companies code. Source and binary forms of these programs are distributed along with Antares\_Simulator with NO WARRANTY:** -- Wxwidgets 3.1.3 Copyright (c) 1998-2017 The wxWidget Team - [https://github.com/wxWidgets/wxWidgets.git](https://github.com/wxWidgets/wxWidgets.git) - license: wxWindows Library License,V3.1 [https://spdx.org/licenses/wxWindows.html](https://spdx.org/licenses/wxWindows.html) - - libYuni 1.1.0 [https://github.com/libyuni](https://github.com/libyuni) license: Mozilla Public License 2.0 [https://spdx.org/licenses/MPL-2.0.html](https://spdx.org/licenses/MPL-2.0.html) diff --git a/docs/user-guide/other-features/kirchhoff-constraints-builder.md b/docs/user-guide/other-features/kirchhoff-constraints-builder.md index 5aecd43e30..7f69bd8cc5 100644 --- a/docs/user-guide/other-features/kirchhoff-constraints-builder.md +++ b/docs/user-guide/other-features/kirchhoff-constraints-builder.md @@ -11,8 +11,6 @@ Binding Constraints can take many forms (hourly, daily, weekly), involve flows o In other words, it is possible to make Antares work as a genuine DC OPF, provided that consistent binding constraints are written down for each cycle belonging to any cycle basis of the graph made out from all AC components of the power system (V vertices, E edges). -The declaration of binding constraints can be made manually through the regular GUI. However, it is preferable not to carry out this task that way because there are many different possible formulations, among which some are better than others: - - In a fully connected graph (V, E), there are as many binding constraints to write down as there are cycles in any cycle basis of the graph, which amounts to (E+1-V). The number of different possible basis is equal to that of spanning trees, which can be assessed by the Kirchhoff's theorem [^15] - Among all cycle basis, some should be preferred to others because they lead to a sparser constraint matrix. @@ -44,8 +42,6 @@ Besides, the KCG takes into account the fact that the "best estimates" of all cr From a practical standpoint, assessments of $Y^-, Y^+$ should be derived from knowledge about the actual components installed on the grid, while $Z_l$ and $ \varphi_l $ can be estimated by various methods. -In addition to the previous functionalities, the KCG's GUI also includes the following options: - - Choice of a specific period of time for which the constraints should be applied, while completely relaxed at other moments - Before actual generation of binding constraints, preview of the "minimal length" spanning tree used as starting point for the optimal basis algorithm (left column of the table – links displayed with "0" do not belong to the tree) - Before actual generation of binding constraints, preview of the "optimal cycle basis" used as starting point for constraints generation (right column of the table – links displayed with "n" appear in n different cycles of the basis) @@ -77,8 +73,6 @@ The binary is located in Antares_Simulator/bin/ **option_file_path**: Optional. The path of the **constraintbuilder.ini** file. It's normally located in *study_path/settings/*. If not provided the constraint builder will take the default values, which are defined at the end of cbuilder.h. -Those values were used to fill the GUI default values, and then the GUI created the file. That's why it's optional since only the default values are guaranteed to work. - ### Results New constraints generated this way will be stored in *input/bindingconstraints/* with the name uto_0001.txt, @@ -93,4 +87,4 @@ The study only needs to include the following components to generate kirchhoff c - Areas (contains links) - Binding Constraints -- version number \ No newline at end of file +- version number diff --git a/src/distrib/win32/NSIS.template.in b/src/distrib/win32/NSIS.template.in index e9aed605af..69b052514e 100644 --- a/src/distrib/win32/NSIS.template.in +++ b/src/distrib/win32/NSIS.template.in @@ -333,11 +333,9 @@ ${MementoSection} "$(LngCoreFiles)" SecCore ${File} "${ANTARES_BUILD_DIR}\ui\simulator\resources\images\misc" "*.png" ${File} "${ANTARES_BUILD_DIR}\ui\simulator\resources\images\misc" "*.gif" ${SetOutPath} "$INSTDIR\Resources\Help" - ${FileOptionnal} "${ANTARES_BUILD_DIR}\ui\simulator\resources\help\" "system-map-editor-reference-guide.pdf" ${FileOptionnal} "${ANTARES_BUILD_DIR}\ui\simulator\resources\help\" "antares-examples-library.pdf" ${SetOutPath} "$INSTDIR\Documentation" - CreateShortCut "$INSTDIR\Documentation\System Map Editor reference guide (PDF).lnk" "$INSTDIR\Resources\Help\system-map-editor-reference-guide.pdf" "" "" CreateShortCut "$INSTDIR\\Documentation\Examples library (PDF).lnk" "$INSTDIR\Resources\Help\antares-examples-library.pdf" "" "" ${registerExtension} "$INSTDIR\bin\${ANTARES_BIN}" ".antares" "Antares Study ${CMAKE_SIMPLE_VERSION}" @@ -385,7 +383,6 @@ ${MementoSection} "Menu Shortcuts" SecMenuShortcuts CreateShortCut "$SMPROGRAMS\RTE Antares ${PRODUCT_VERSION}\Antares Simulator ${PRODUCT_VERSION}.lnk" "$INSTDIR\bin\${ANTARES_BIN}" "" "$INSTDIR\Resources\Icons\study.ico" CreateShortCut "$SMPROGRAMS\RTE Antares ${PRODUCT_VERSION}\Documentation\Data Organizer reference guide (PDF).lnk" "$INSTDIR\Resources\Help\data-organizer-reference-guide.pdf" "" "" CreateShortCut "$SMPROGRAMS\RTE Antares ${PRODUCT_VERSION}\Documentation\Data Organizer troubleshooting (PDF).lnk" "$INSTDIR\Resources\Help\data-organizer-troubleshooting.pdf" "" "" - CreateShortCut "$SMPROGRAMS\RTE Antares ${PRODUCT_VERSION}\Documentation\System Map Editor reference guide (PDF).lnk" "$INSTDIR\Resources\Help\system-map-editor-reference-guide.pdf" "" "" CreateShortCut "$SMPROGRAMS\RTE Antares ${PRODUCT_VERSION}\Documentation\Examples library (PDF).lnk" "$INSTDIR\Resources\Help\antares-examples-library.pdf" "" "" CreateShortCut "$SMPROGRAMS\RTE Antares ${PRODUCT_VERSION}\Documentation\Software License Agreement (PDF).lnk" "$INSTDIR\Resources\Help\software-license-agreement.pdf" "" "" ${Mementosectionend}