Installation

Installation files for the Vortex® Studio family of products are available from the CM Labs Account Page (https://www.cm-labs.com/account/).

Warning
It is a recommended best practice to install Vortex software under the same Windows user account that you will use when running the Vortex application.
Note
Microsoft Visual C++ 2010 and 2015 Redistributable Packages are required for any Vortex Studio installation.
In some cases, if you already have the correct or higher version of the package installed, Vortex Studio will fail to install and prompt you to download a redistributable package. Trying to install that linked version will also fail since it will register as an older version than what you have on your machine. In this case, you must repair the redistributable package from the "Apps & Features" tool (in Windows 10), or the "Uninstall or Change a Program" page found via the Control Panel.

Available Installers on CM Labs Account Page

Windows

Component Installer Description
Vortex Studio Setup VortexSetup.exe

Bundle installer. Sequentially installs Vortex Studio, additional add-ons and libraries, as selected by the user.

Vortex Studio Vortex_Studio_<VERSION>_x64_vx14.msi

This file includes the installation of Vortex Studio Player, Editor, SDK, plugins, and tutorials.

(Compatible with Visual Studio 2014.)

Vortex Studio DebugKit Vortex_Studio_DebugKit_<VERSION>_x64_vc14.msi

This add-on provides all the required files for development debugging.

(Compatible with Visual Studio 2014.)

Vortex Studio Human Data Vortex_Studio_Human_Library_<VERSION>.msi

This additional library contains the models needed by the Vortex Studio Human add-on. This needs to be installed for editing as well as for runtime.

Vortex Studio Vegetation Library Vortex_Studio_Vegetation_Library_<VERSION>.msi

This additional library contains the models needed by the Vortex Studio Vegetation add-on. This needs to be installed for editing as well as for runtime.

Vortex Studio Documentation Vortex_Studio_Documentation_<VERSION>.msi

Technical and User Documentation.

Vortex Studio Samples Vortex_Studio_Samples_<VERSION>.msi

Samples demonstrating functionalities of Vortex Studio.

Vortex Studio Licensing Tool Vortex_Licensing_Tools_<VERSION>_x64_win32_vc14.msi

License tool, Hostid tool.

Linux

Component Installer Description
Vortex Studio Vortex_Studio_<VERSION>_x64_gcc48.tar Vortex Studio for Linux.
Vortex Studio Documentation Vortex_Documentation_<VERSION>.zip Technical and User Documentation.

Bundle Installer

After downloading the Vortex Studio Setup file and all relevant components, add-on and library packages to the same folder, you can install Vortex Studio either locally or in distributed mode on selected workstations.

Local Installation

  1. Browse to the location of the Vortex Studio Setup file and double-click it to start the setup application.
  2. In the next window, click Install Locally.
  3. In the following window, clicking the Custom button allows you to select which components to install, as well as to modify the installation location. You will also see which components you already have installed, if any.
  4. Click Next.
  5. After reading the license terms and conditions, select the agreement box and click Next.
  6. A status window appears, displaying global and partial progress.

    Note
    If there is an error during installation, an error page appears with a link to access the installation log file.
    If an MSI file is missing from the bundle setup folder, the installer will warn you which component is missing. To correct the problem, you must copy the missing component to the installation folder and run the installation again.

Network Installation

  1. Browse to the location of the Vortex Studio Setup file and double-click it to start the setup application.
  2. In the next window, click Install on Network. A running Vortex Service is the only application required for deployment on a selected workstation.
  3. Select the computers from the chosen network interface where you want to install Vortex Studio. Click Next.
  4. A status window appears, displaying global and partial progress.
Note
  • Downgrading (i.e., going from a more recent build number to an earlier build number of the same version) is not supported. Prior un-installation is mandatory in this case, and must be performed before the installation.
  • Co-existence of Vortex Toolkit versions is supported (e.g., 2018c and 2019a on the same workstation).

Upgrade Installation

To upgrade your version of Vortex Studio, follow the same steps as for a new installation.

Note
All components already installed are selected by default at the customization stage of the installation.

Note that:

Remove Installation

To remove Vortex Studio, use the usual Windows uninstall procedure through Control Panel.

Vortex Studio Directory Structure

By default, Vortex® Studio is installed under the CM Labs root folder (C:\CM Labs for Windows) in a directory matching your environment configuration under Vortex Studio 2019a (for example, C:\CM Labs\Vortex Studio [current version]\).

Its sub-directories provide access to the following elements:

Sub-directory Contents
3rd party Third-party libraries and source files.
bin Vortex's dynamic-linked libraries (DLLs).
include Header (.h) files, organized in directories.
lib Release and debug libraries (or on Windows, import libraries). Debug files contain a "d" after the Vortex version number (for example, VxCore6d.lib).
plugins Special plugin libraries that Vortex loads via the Plugin Manager.
tutorials Code samples you can compile and run in Vortex.
Note
By default, the documentation and samples are not included with the Vortex Studio installation. You can download and install them from www.cm-labs.com by selecting the matching installers, in which case they are installed in the C:\CM Labs\Vortex Documentation 2019a, C:\CM Labs\Vortex Samples 2019a, and C:\CM Labs\Vortex Licensing Tools directories.