This section guides first-time contributors through installing FLINT development environment.
Before proceeding further, make sure you have setup the project using Git by following our guide Git and GitHub Guide. Also make sure you have the following prerequisites setup.
Now that you have all the necessary prerequisites, you can proceed with the Installation.
Using vcpkg to install required libraries¶
Start a command shell in the Vcpkg repository folder (that you had cloned earlier) and use the following commands:
# bootstrap bootstrap-vcpkg.bat # install packages vcpkg.exe install boost-test:x64-windows boost-program-options:x64-windows boost-log:x64-windows turtle:x64-windows zipper:x64-windows poco:x64-windows libpq:x64-windows gdal:x64-windows sqlite3:x64-windows boost-ublas:x64-windows fmt:x64-windows libpqxx:x64-windows
Setting up the FLINT development environment¶
Clone the FLINT repository in the moja-global folder from here
After cloning the FLINT repository, switch to
Start command shell in the FLINT folder of your system and run command:
cd FLINT git checkout develop
Using CMake to build the project¶
Start a command shell in your FLINT core repository folder. Now use the following commands to create the Visual Studio solution:
# Create a build folder under the Source folder cd Source mkdir build cd build # from ..\moja\FLINT\source\build # now create the Visual Studio Solution (2019) cmake -G "Visual Studio 16 2019" -DCMAKE_INSTALL_PREFIX=..\..\.. -DVCPKG_TARGET_TRIPLET=x64-windows -DENABLE_TESTS=OFF -DENABLE_MOJA.MODULES.ZIPPER=OFF -DCMAKE_TOOLCHAIN_FILE=..\..\..\vcpkg\scripts\buildsystems\vcpkg.cmake .. # OR Visual Studio Solution (2017) cmake -G "Visual Studio 15 2017" -DCMAKE_INSTALL_PREFIX=..\..\.. -DVCPKG_TARGET_TRIPLET=x64-windows -DENABLE_TESTS=OFF -DENABLE_MOJA.MODULES.ZIPPER=OFF -DCMAKE_TOOLCHAIN_FILE=..\..\..\vcpkg\scripts\buildsystems\vcpkg.cmake ..
All paths used below with
C:\Development\moja-global will need to
be modified to match your system build location of the moja project.
Building the FLINT¶
Run a command shell and navigate to the build folder.
moja.sln in the command prompt. Visual studio is launched.
- After Visual Studio has loaded completely, move to the Solution Explorer in the top right, expand the CMakePredefinedTargets and select ALL_BUILD.
- Right click on ALL_BUILD and click on Build in the menu.
If the output says Build 7 succeeded as shown in the image below, FLINT has built successfully.
To see the freshly compiled FLINT executable, open the build folder and in the command prompt type:
moja.cliin the command prompt.
You see this output:
Running the project¶
We are running the
moja.cli.exe from the moja.FLINT project here. In
order to make edits to the Visual Studio Solution we can use the CMake
Edit solution using CMake GUI¶
Launch the CMake GUI
Where to build the binariesfield click
Browse Build…and select the folder you created above (i.e.
Where is the source code:field should update, if not, set it correctly.
You should be able to edit any CMake setting now (i.e. ENABLE flags like
ENABLE_TESTS), then click
Configure– assuming all libraries and required software has been installed you should have no errors. Now click
Generateand the Solution with adjustments should be ready to load into Visual Studio.
FLINT Core Installation Video Tutorial¶
The above steps for installation of FLINT on Windows with Visual Studio can also be followed along with the video tutorial: