The Custom Installation setup provides several options to control your installation, including specifying the location, creating a shortcut, and whether to install dependencies. These instructions apply mostly to Windows, but the same concepts could also apply to macOS and Linux.

Installing in non-default user home directory​

If your default user home directory contains spaces or illegal characters, the ModusToolbox™ installer prevents you from installing into that directory. For example:


../figures/image6.png

If possible, create a new user account and user home directory that doesn’t contain spaces or illegal characters. Then, you can just use the default process for that account.

If you cannot create a new user home directory, then you must perform some extra manual installation steps.

Choosing the custom option​

If your default installation directory contains spaces or illegal characters, or if you want to install the ModusToolbox™ tools package in a non-default location, select the

Custom Installation

option on the installer:



Install at a custom path​

If you specify a

non-default location

, a message displays as a reminder to set the

CY_TOOLS_PATHS

environment variable. You will also have to specify a few other variable when the installer completes.



Specify an alternate installation path that does not include spaces. For example:

C:\MyPath\ModusToolbox

Any path without spaces or illegal characters will work.

Select additional tasks​

On the next step, you can choose to create a desktop shortcut and install dependencies.



Click

Next

and then

Finish

to install the software.

Create directories​

  1. After installation is complete, create a hidden "dot" directory named ".modustoolbox" for content described later in this section. For example:

    C:\MyPath\

    .

    modustoolbox

  2. Also, create a directory to store your workspaces. You can choose any path as long as it doesn’t contain spaces. For example:

    C:\MyPath\mtb-projects

Create variable to specify the path to Tools​

Because you are installing ModusToolbox™ into a non-default location, you need to specify the path to your "tools" directory using an Environment Variable. Open the Environment Variables dialog, and create a new System or User Variable, depending on your installation type (current user or all users). For example:

CY_TOOLS_PATHS = C:/MyPath/ModusToolbox/tools_3.4

Note:

Use a Windows-style path (not Cygwin-style, like /cygdrive/c/). Also, use forward slashes.

Create variable to specify the global path​

You also need to specify the global path using an Environment Variable. Open the Environment Variables dialog, and create a new System or User Variable, depending on your installation type (current user or all users). For example:

CY_GETLIBS_GLOBAL_PATH = C:/MyPath/.modustoolbox/global

Note:

Use a Windows-style path (not Cygwin-style, like /cygdrive/c/). Also, use forward slashes.

Specify the custom path to use for Local Content Storage​

If you use Local Content Storage (LCS) to enable work without access to the Internet, set this variable to specify where the content will be stored. For example:

MTB_LOCAL_CONTENT_PATH = C:/MyPath/.modustoolbox/lcs