Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
How a successful CMake run should look like
  • Loading branch information
franziska-wegner committed Dec 2, 2023
1 parent 693de1c commit 56a1e7b
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,66 @@ Most parameters represent flags and can be enabled with `ON` if available and `O

This framework provides a set of unittests that uses the Google Test Framework as base. The CMake files allow two different setups of the test framework that are known by online and offline configuration. The CMake parameter for the online version are `"EGOA_TEST_FRAMEWORK": "OnlineGoogleTestFramework"` OR `"EGOA_TEST_FRAMEWORK": "OfflineGoogleTestFramework"` with the pointer to the installation directory of the Google test framework repository, e.g., `"EGOA_TEST_FRAMEWORK_LOCATION": "external/GoogleTestFramework"`.

<h3>Successful Initial CMake Run</h3>

```
--
-- /Users/fwegner/Documents/Repositories/Public/EGOA/egoa
--
-- /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug
-- Set OpenMP variables
-- OMP_WAIT_POLICY: ACTIVE
-- OMP_STACKSIZE:
-- OMP_SCHEDULE:
-- OMP_PROC_BIND: TRUE
-- OMP_THREAD_LIMIT: 0
-- Number of processors: 8
-- OMP_NUM_THREADS: 8
--
-- Compiler extra flags: -pedantic -Werror -Wall -Wextra -Wunused-result -Wno-error=unused-but-set-variable -Wno-error=conversion -Wshadow -Wno-error=zero-length-array
--
-- Download of data sets:
-- Download PyPSA Europe data from https://github.com/PyPSA/pypsa-eur.git into /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/data/PowerGrids/PyPSA/pypsa-eur.
-- Download PyPSA ITI Collaboration data from https://git.scc.kit.edu/FN/iti-collaboration.git into /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/data/PowerGrids/PyPSA/pypsa-iti-collaboration.
-- Download IEEE Power Grid data.
--
-- Looking for Qt6
-- Could NOT find WrapVulkanHeaders (missing: Vulkan_INCLUDE_DIR)
-- Could NOT find WrapVulkanHeaders (missing: Vulkan_INCLUDE_DIR)
-- Found Qt6 Core module in "/opt/homebrew/lib/QtCore.framework/Versions/A/QtCore"
-- Found Qt6 Quick module in "/opt/homebrew/lib/QtQuick.framework/Versions/A/QtQuick"
-- Found Qt6 Widgets module in "/opt/homebrew/lib/QtWidgets.framework/Versions/A/QtWidgets"
-- Found Qt6 Concurrent module in "/opt/homebrew/lib/QtConcurrent.framework/Versions/A/QtConcurrent"
SRC=/Users/fwegner/Documents/Repositories/Public/EGOA/egoa and Binary=/Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug
-- Doxygen: /opt/homebrew/bin/doxygen
-- Google Test Framework
-- EGOA_ENABLE_TESTS: ON
--
-- Neither OGDF nor COIN include directory and library are added to the project.
--
-- Compiler:
-- CMAKE_C_COMPILER: /opt/homebrew/opt/llvm/bin/clang
-- CMAKE_CXX_COMPILER: /opt/homebrew/opt/llvm/bin/clang++
-- make VERBOSE = 1? : TRUE
--
-- Other important targets:
-- qt6: add libraries of QT6
-- doc: build doxygen documentation
-- EGOA Exceptions: ON
-- EGOA Assertions: ON
--
-- Build type is set to: Debug
-- Build files have been written to: /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug
-- Runtime output directory: /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug/bin
-- Archive output directory: /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug/lib
-- Library output directory: /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug/lib
--
-- Configuring done (3.2s)
-- Generating done (0.1s)
-- Build files have been written to: /Users/fwegner/Documents/Repositories/Public/EGOA/egoa/build-debug
[Finished in 3.4s]
```

<h2>Recommended IDEs</h2>

A general recommendation is CLION and Sublimetext. However, Visual Studio and others work fine as well.
Expand Down

0 comments on commit 56a1e7b

Please sign in to comment.