Running the Visualizer

Running the Visualizer

---

1.0) BioGears Core Install

Set-up starts with your BioGears solution. Make sure you are up to date on master, and that you are set up in Visual Studios in the Release configuration. Using CMake, set your CMAKE_INSTALL_PREFIX variable to a writable folder (e.x "usr" in your BioGears folder). An example is shown below, but the specific paths you use will depend upon your specific folder setup.

Then build the solution (hit F7). Once successful, right click on "Install" on the left hand side of the screen (in the solution explorer as shown below) and build install. Now, repeat the build of the solution and the install in the debug configuration. Once you have built in both configurations, you are ready to move on to setting up the visualizer solution.

2.0) Building the Visualizer

2.1 Preparing the Solution

To begin, make sure your copies of visualizer and external (both are submodules of BioGears) are up to date. Before you CMake:

1. Create a folder within your visualizer folder titled "build"
2. Point the source code and the binaries to the visualizer (refer to image below)
3. Add paths for usr and the windows external
   1. Click add entry
   2. Specify the name as "CMAKE_PREFIX_PATH"
   3. Specify the type as a path
   4. Enter the path to each folder (usr and windows-vc15-amd64 respectively) as the value
   5. Click OK

Before configuring, your CMake should appear as above, making sure the Prefix Paths are separated by a semicolon. Again, the specific path will depend on how you configured your folders.

2.2 Running CMake for the Visualizer

Once done, configure, generate, and open the project.

3.0) Running the Visualizer

3.1 Preparing the Solution

Once open in Microsoft Visual Studios (MVS), right-click on BioGearsUI on the lefthand side of the screen in the Solution Explorer. Switch the configuration in the top left corner of the property page to be "All Configurations." On the left hand side of the screen, navigate to Configuration Properties→Debugging, and fill in the Environment box with the QT Path:       QT_PLUGIN_PATH=D:\remotes\sed-stash\biogears\external\windows-vc15-amd64\plugins Note: The above path is an example. Be sure to switch the path to your specific plugin folder of the windows build based on your folder configuration.

3.2 Build the Solution

Specify the configuration (release or debug) you wish to build in at the top of the MVS screen. Click the F7 key or navigate to the Build→Build Solution tab at the top of the screen. Make sure the build is successful.

Then, navigate in the solution explorer to CMakePredefinedTargets→STAGE, right-clock on stage, and select build. Make sure this build is also successful.

3.3 Run the Visualizer

Click F5 or click the play button to run the solution. The viualizer/UI should pop up and prompt you with further directions.

Note: The visualizer is not currently fully functional at this point in time. These directions serve to make sure you can build and run it properly.

Practice: Make sure the UI builds/runs in both release and debug