Installing Prerequisite Software on Windows - QuanergySystems/quanergy_client GitHub Wiki

Installing Prerequisite Software on Windows

In this section, two tested approaches for installing required software are shared:

  • The “Newer VS 2015 Build,” starting below.
  • The "Older VS 2013 Build,” starting on page 21.

NOTE: Whenever a computer window pops up to ask if you want to open an executable file or allow the app to make changes, click the Yes button.

Newer VS 2015 Build

Specific newer versions of various essential software packages were tested and proven to work well with Quanergy’s client-server model via Windows 7 64-bit. If you are missing any of the following four packages.

  • Visual Studio 2015: Community Edition with Update 3, Visual C++ Installed (below)
  • CMake Version 3.9.4 (see page 14)
  • Windows SDK for Windows 8.1 (see page 16)
  • PCL 1.8.0 All-In-One Installer MSVC2015 x64 (see page 18)

Install them in the order above, as instructed below, then update the environment variables as explained on page 28.

Visual Studio 2015: Community Edition with Update 3, Visual C++ Installed

Visual Studio: Community 2015 is Microsoft’s integrated development environment (IDE) that enables the development of cross-platform solutions in native code and managed code formats. If you don’t already have it:

  1. Download Visual Studio 2015 as follows:
  • Navigate to the following URL in a web browser: https://www.visualstudio.com/vs/older-downloads

  • In the 2015 section near the top of the webpage, click the Download button (Figure 3 top).

  • If you don’t already have a free, perpetual subscription to the Dev Essentials program, a window appears where you can sign up and access the application (Figure 3 bottom).

  • This subscription gives you access to the older versions. Click the Download button for the Visual Studio Community 2015 with Update 3 (Figure 4).

 Figure 3. New: VS 2015 Select 2015 Version (top), Subscribe Dev Essentials (bottom)

 Figure 4. New: VS 2015 Download

  1. Navigate to the computer’s Downloads folder where the en_visual_studio_ community_2015_with_update_3_x86_x64_web_installer_8922963 file was saved, then double-click the file to launch it.

  2. The Visual Studio wizard displays a timer while initializing setup. When complete, the wizard offers several opportunities (Figure 5 left):

  • Confirm that the installation location filepath is: C:\Program Files (x86)\Microsoft Visual Studio 14.0

  • Select the Custom type of installation, then leave all the options enabled that make sense. It’s especially important to enable C++.

  • Read the License Terms and Privacy Statement if you wish.

  • Click the Install button.

  1. The Visual Studio window displays Acquiring and Applying visual timers (not shown). Click the Launch button when the process is complete (Figure 5 right).

 Figure 5. New: VS 2015 Destination, Installation, License/Privacy (left), Launch (right)

  1. A Welcome window appears. Sign in or sign up for an account, or proceed without signing in by clicking the Not now, maybe later link (Figure 6 left).

  2. A Start window appears where you select an environment from the Development Settings menu, select a color theme, then click the Start Visual Studio button (Figure 6 right).

  3. Click the X button in the upper right corner to quit Visual Studio.

  4. Continue to the next section to install the CMake application.

 Figure 6. New: VS 2015 Welcome/Sign In (left), Setup/Start (right)

CMake Version 3.9.4

CMake Version 3.9.4 is an open-source, cross-platform suite of software tools for building, testing, and packaging software solution files that can be opened in Visual Studio. It supports complicated directory hierarchies and applications that rely on multiple libraries. If you don’t already have it:

  1. Navigate to the following URL in a web browser (or click the CMake link in the GitHub Build Instructions) to automatically download the application: https://cmake.org/files/v3.9/cmake-3.9.4-win64-x64.msi

  2. Navigate to the computer’s Downloads folder where the cmake-3.9.4-win64-x64.msi file has been saved, then double-click the file to launch the CMake Setup Wizard instructions for installing CMake.

  3. Click the Welcome window’s Next button (Figure 7 left).

  4. Read through the licensing terms if you wish, and when you’re done check the I accept the terms... checkbox (Figure 7 right) and click the Next button.

 Figure 7. New: CMake Welcome (left), License Agreement(right)

  1. From the list of installation options that appears, select the second option Add CMake to the system PATH for all users, check the Create CMake Desktop Icon checkbox, and click the Next button (Figure 8 left).

  2. In the Destination Folder window that appears, confirm or update the path for where all CMake-generated files will be stored, and click the Next button (Figure 8 right).

 Figure 8. New: CMake System PATH (left), Destination Folder (right)

  1. In the Ready to install CMake window, click the Install button (Figure 9 left).

  2. When the installation has completed, select the Finish button (Figure 9 right).

 Figure 9. New: Ready to Install CMake (left), Finish (right)

  1. Continue to the next section to install the Windows SDK for Windows 8.1.

Windows SDK for Windows 8.1

The Windows Software Development Kit (SDK) for Windows 8.1 contains headers, libraries, and tools necessary for creating apps that run on the Windows OS. If you don’t already have it, install it as follows:

  1. Navigate to the following URL in a web browser (or click the SDK link in the GitHub Build Instructions): https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk

  2. On the web page, click the Install and download button (Figure 10).

 Figure 10. New: Windows SDK Download

  1. Navigate to the computer’s Downloads folder where the sdksetup.exe file has been saved, then double-click the file to launch it.

  2. In the Specify Location window that appears, accept the default installation path by clicking the Next button (Figure 11 left).

  3. In the Join the Customer Experience Improvement Program (CEIP) window that appears, make your selections as preferred, and click the Next button (Figure 11 right).

 Figure 11. New: Windows SDK Specify Location (left), CEIP (right)

  1. In the License Agreement window that appears, click the Accept button (Figure 12 left).

  2. In the Select the features... window that appears, accept defaults, and click the Install button (Figure 12 right).

  3. The Installing Features window displays a visual timer, then displays a Welcome message when complete (Figure 12 bottom).

  4. Click the window’s Close button (not shown).

 Figure 12. New: Windows SDK License (left), Features (right), Welcome (bottom)

  1. Continue to the next section to install PCL 1.8.0.

PCL 1.8.0 All-In-One Installer MSVC2015 x64

PCL 1.8.0 All-In-One Installer MSVC2015 x64 is an installer for rapidly building a development environment for the open source point cloud library (PCL) of three-dimensional point cloud processing using pre-built binaries with Visual Studio 2015. If you don’t already have it:

  1. Navigate to the following URL in a web browser (or click the PCL 1.8.0... link in the GitHub Build Instructions): http://unanancyowen.com/en/pcl18

  2. On the page that appears, scroll down until you reach the Visual Studio 2015 section, as shown in Figure 13, and click the CL 1.8.0 All-in-one Installer MSVC2015 x64 item.

 Figure 13. New: PCL 1.8.0 All In One Selection

  1. You may need to sign into a Microsoft account and set up a OneDrive account.

  2. Navigate to the computer’s Downloads folder where the PCL-1.8.0-AllInOne-msvc2015-win64 executable file has been saved, then double-click the file to launch it.

  3. After the Welcome message appears, click the Next button (Figure 14 left).

  4. Read the license agreement if you wish, then click the I Agree button (Figure 14 right).

 Figure 14. New: PCL 1.8.0 Welcome (left), License (right)

  1. From the list of installation options that appears, select the Add PCL to the system PATH for all users option, and click the Next button (Figure 15 left).

  2. In the Destination Folder field that appears, confirm the automatically generated path, C:\Program Files\PCL 1.8.0, and click the Next button (Figure 15 right).

 Figure 15. New: PCL 1.8.0 Options (left), Destination (right)

  1. In the Choose Start Menu Folder window, confirm that the correct folder name is printed in the field, and click the Next button (Figure 16 left).

  2. In the Choose Components window, confirm that the checkboxes for both PCL and 3rd Party Libraries component features are checked, and click the Install button (Figure 16 right).

 Figure 16. New: PCL 1.8.0 Start Menu Folder (left), Features (right)

  1. An Installing window displays a visual timer.

  2. The PCL wizard opens an OpenNI wizard. In the OpenNI Destination Folder window that appears, click the Install button (Figure 17 left).

  3. When a query appears to make sure it’s okay to continue, click the Install button.

  4. When the OpenNI “Completed...” message appears, click the Finish button (Figure 17 right) to resume to the PCL wizard.

 Figure 17. New: OpenNI Destination (left), Complete (right)

  1. When the PCL wizard’s “Completing...” message appears, click the Finish button (Figure 18) to close the installation wizard.

 Figure 18. New: PCL 1.8.0 Install Completion

  1. Skip to page 28 to update the environment variables.

Older VS 2013 Build

Specific older versions of various essential software packages were tested and proven to work well with Quanergy’s client-server model via Windows 7 64-bit. If you are missing any of the following four packages.

  • Visual Studio 2013: Community Edition with Update 5 (see below)
  • CMake Version 3.9.4 (see page 24)
  • Visual C++ Redistributable Packages for Visual Studio 2013 (see page 25)
  • PCL 1.8.0 All-In-One Installer MSVC2013 x64 (see page 27)

Install them in the order above, as instructed below, then update the environment variables as explained on page 28.

Visual Studio 2013: Community Edition with Update 5

Visual Studio: Community 2013 is Microsoft’s integrated development environment (IDE) that enables the development of cross-platform solutions in native code and managed code formats. If you don’t already have it:

  1. Download Visual Studio 2013 as follows:
  • Navigate to the following URL in a web browser: https://www.visualstudio.com/vs/older-downloads

  • In the 2013 section midway down the webpage, click the Download button (Figure 3 top, on page 11).

  • If you don’t already have a free, perpetual subscription to the Dev Essentials program, a window may appear where you can sign up and access the application (Figure 3 bottom, on page 11).

  • This subscription gives you access to the older versions. Click the Download button for the Visual Studio Community 2013 with Update 5 (Figure 19).

 Figure 19. Old: VS 2013 Download

  1. Navigate to the computer’s Downloads folder where the en_visual_studio_ community_2013_with_update_6_x86_6816332 file was saved, then double-click the file to launch it.

  2. The Visual Studio wizard displays a timer while initializing setup. When complete, the wizard offers several opportunities (Figure 20 left):

  • Confirm that the installation location filepath is C:\Program Files (x86)\Microsoft Visual Studio 12.0

  • Read the License Terms and Privacy Policy if you wish, click the I agree checkbox.

  • Click the Next button that appears.

  1. The next Visual Studio window appears and recommends Optional features to install (Figure 20 right). Click the Select All checkbox (or select all items that make sense), then click the Install button.

 Figure 20. Old: VS 2013 Destination/License/Privacy (left), Features (right)

  1. The Visual Studio window displays Acquiring and Applying visual timers (Figure 21 left). Click the Launch button when the process is complete (Figure 21 right).

 Figure 21. Old: VS 2013 Acquiring/Applying (left), Launch (right)

  1. After a wait, a Welcome window appears. Sign in or sign up for an account, or proceed without signing in by clicking the Not now, maybe later link (Figure 22 left).

  2. A Visual Studio startup window appears. Select an environment from the Development Settings drop-down menu, then select a color theme (Figure 22 right).

  3. After making selections, click the Start Visual Studio button (Figure 22 right).

 Figure 22. Old: VS 2013 Welcome/Sign In (left), Setup/Start (right)

  1. The Visual Studio application opens with a Start Page window of relevant news links (Figure 23). Click the application window’s upper right X button to quit Visual Studio.

 Figure 23. Old: Visual Studio Start Page Tab

  1. Continue to the next section to install the CMake application.

CMake Version 3.9.4

The installation of CMake Version 3.9.4 was previously explained. If you don’t already have it installed on your host computer:

  • Complete the “CMake Version 3.9.4” instructions starting on page 14.

  • Continue with the “Visual C++ Redistributable Packages for Visual Studio 2013” section starting on page 25.

Visual C++ Redistributable Packages for Visual Studio 2013

Visual C++ Redistributable Packages for Visual Studio 2013 provides the run-time components that are necessary to run C++ applications that are built through the Visual Studio 2013 IDE. If you don’t already have it:

  1. Open the following URL in a web browser: https://www.microsoft.com/en-us/download/details.aspx?id=40784

  2. On the homepage for that software, select a preferred language, then click the Download button, as shown in Figure 24.

 Figure 24. Old: Visual C++ Redist. Packages Home Page

  1. In the Choose the download... window that appears, select the vcredist_x64.exe option, and click the Next button (Figure 25).

 Figure 25. Old: Visual C++ Redist. Packages Request Download

  1. Navigate to the computer’s Downloads folder where the vcredist_x64.exe file has been saved, then click the file to launch it.

  2. Read through the license terms and conditions if you wish, check the checkbox agreeing to them, and click the Install button to begin the automatic installation process (Figure 26 left).

  3. When installation is complete and the Setup Successful message appears, click the Close button (Figure 26 right).

 Figure 26. Old: Visual C++ Redist. Packages Terms/Conditions (left), Success (right)

PCL 1.8.0 All-In-One Installer MSVC2013 x64

PCL 1.8.0 All-In-One Installer MSVC2013 x64 is an installer for rapidly building a development environment for the open source point cloud library (PCL) of three-dimensional point cloud processing using pre-built binaries with Visual Studio 2013. If you don’t already have it:

  1. Navigate to the following URL in a web browser (or click the PCL 1.8.0... link in the GitHub Build Instructions): http://unanancyowen.com/en/pcl18

  2. On the page that appears, scroll down until you reach the Visual Studio 2013 section, as shown in Figure 13, and click the PCL 1.8.0 All-in-one Installer MSVC2013 x64 item.

 Figure 27. Old: PCL 1.8.0 All In One Selection

  1. You may need to sign into a Microsoft account and set up a OneDrive account.

  2. Navigate to the computer’s Downloads folder where the PCL-1.8.0-AllInOne-msvc2013-win64.exe file was saved, then double-click the file to launch it.

  3. Complete the “PCL 1.8.0 All-In-One Installer MSVC2015 x64” instructions starting with Step 5 on page 13. The screenshots reference 2015 instead of 2013, but the sequence is the same with one exception: the wizard may not enable installation of the OpenNI libraries. (You will have the opportunity to install them later, as instructed on page 34.)

  4. Continue with the “Setting Environment Variables” section starting on page 28.