BPS Support

cancel
Showing results for 
Search instead for 
Did you mean: 

Downloading & Installing BPS

The latest version of BEEcube Platform Studio (BPS) is version 5.5.

  

Downloading BPS

 

Click here to download the BPS installer (zip file, 29 MB). Once the download completes, extract the contents to a local directory on your computer.

 

Installing BPS

 

The BPS tool flow for hardware/software generation operates entirely within the The Mathworks, Inc. MATLAB® software environment and does not strictly require that it be installed locally on your workstation.  However, an installer is provided for your convenience which will automatically unpack the BPS software distribution and configure your MATLAB® environment to include the BPS tool set.  Alternatively, you may unpack the distribution into a directory of your choice and manually set up your MATLAB® environment to suit your usage model.  The remainder of this chapter describes both methods for installing BPS in your design environment.

 

System Requirements

 

This version of BPS has been designed for and tested with the following third-party tools, listed by vendor:

  • The Mathworks, Inc.
    • MATLAB®/Simulink® R2015b
  • Xilinx
    • Vivado Design Suite-HLx Edition 2015.4 including SDK

BPS is supported for use on 64-bit Windows and 64-bit Linux operating systems only.  Please refer to the operating system requirements imposed by each of the third-party tools above for specifically supported versions.

 

Using the BPS Installer (Windows/Linux)

 

BPS comes with an installation utility for Windows which will automatically check your environment for all required third-party tools and versions, prompt you for a destination directory, unpack the BPS distribution, and attempt to add the necessary BPS directories to the default MATLAB® path.  Use of the installer is recommended even in shared network environments when the MATLAB® installation may not be modifiable, as it will still check for a number of system requirements and perform all other installation tasks other than changing the default MATLAB® path.

 

Because the BPS installer will verify that supported versions of all required third-party tools are present on the system, please be sure that all required tools in the System Requirements section are installed and properly configured in your current desktop session before continuing.  In addition, it will be necessary to have write permission to the desired install destination directory, so please be sure that the currently logged-in account has sufficient permission to complete the installation.

 

To run the BPS installer, launch the script setup.cmd (setup.sh on Linux machines) which came with the full BPS distribution.  If the script is able to run and successfully launch MATLAB®, the following screen will appear on Windows or the Matlab console directly on Linux:  

 

 

BPS install 1.png

 

Note: The above screenshot only applies to Windows installations. A separate window will not appear on Linux machines.

 

Depending on the speed of your system and/or network, it may take several seconds for MATLAB® to launch and start the installation.  Once the installer is able verify the required tool versions and locate the runtime software archive, the following welcome dialog will appear:

 

 

BPS install 2.png

 

 

Click “OK” to continue, and you will be asked to accept the End User License Agreement for this software, as shown in the following dialog:

 

 

BPS install 3.png

 

 

Click “I agree.”, and then “Continue” to accept the agreement and continue with the installation.  You will then be prompted to select the destination directory for the installation, as shown below:

 

 

BPS install 4.png

 

 

If the selected directory is not already named BPS, the installer will create a subdirectory named BPS first before extracting the runtime software.  Under the resulting directory named BPS, the installer will then extract the runtime software into a directory with the full name of the release.  For example, if the directory C:\Tools was chosen from the “Browse for Folder” dialog, the installer will extract the software into the directory C:\Tools\BPS\BPSvNN_rDDDDDDDD, where NN is the BPS version number, and DDDDDDDD is the build date of the release.  Once the software is successfully extracted, you will see the following dialog appear:

 

 

BPS install 5.png

 

 

The actual dialog that appears may vary, based on whether any warnings were encountered during the installation.  If warnings were reported, please follow any instructions in the dialog to finalize the installation process.

 

NOTE: Windows has a path length limitation of 260 characters. This will have to be taken into account with block naming conventions.

 

Installing BPS Manually (Windows and Linux)

 

NOTE: Manual installation of the BPS tools implies acceptance of the End User License Agreement for this software.  Please read and review the terms of this license before proceeding with any of the steps in this section.

 

You may unpack the BPS runtime software into any location on any filesystem which is accessible from the workstation(s) which will be running MATLAB® and the BPS tools.  Note that the runtime software is included as its own archive within the complete BPS distribution.  The archive filename will be in the format BPSvNN_rDDDDDDDD.zip, where NN is the BPS version number, and DDDDDDDD is the specific build date of the software.

 

In order to use the BPS tools, the user only needs to call the startup script included with BPS from within the MATLAB® environment.  This script only needs to be called once per MATLAB® session, and will be called automatically if MATLAB® is launched from same directory in which the file startup.m exists.

 

For example, if you unpacked the BPS distribution into a directory named C:\BPS, you should either launch MATLAB® in the C:\BPS directory, or launch MATLAB® normally and call the C:\BPS\startup.m script before using any BPS blocks or features:

 

>> cd C:/BPS
>> startup

 

Once the startup script is called and run successfully, the MATLAB® console will display the following message to notify the user that BPS is ready for use:

 

BEEcube Platform Studio configuration complete

 

The primary purpose of the startup.m script is to set up the MATLAB® path to include all the BPS library functions and Blocksets.  Therefore, if you are comfortable with the MATLAB® environment, you may also manually add the paths required by BPS to your own custom MATLAB® startup script or to the MATLAB® configuration for your own user account via the integrated MATLAB® path tools.  This would prevent the need to call startup.m at the beginning of each MATLAB® session.

 

BPS Configuration Options

 

BPS references several environment variables which may be defined to customize your own computing environment.

  • BPS_LICENSE_PATH A colon-separated list of directories to search for valid BPS license files.  Each directory will be checked for a valid license file in the order specified.
  • BPS_BASELIB_PATH A colon-separated list of directories to search for user-created custom base packages.  When a design specifies the use of a custom base package, these directories will be searched for a matching base package before checking the default location.
  • BPS_USER_IP_IMPORT_PATH A directory output initialization for pcores with the use of ip_import. Also the search location for valid imported pcores during Hardware generation.

License Installation

 

BPS requires a valid license to be detected on the system before performing various protected actions.  When searching for a license file, BPS will check any directories listed in the BPS_LICENSE_PATH environment variable (described above) followed by the rest of the MATLAB® path. This gives each user the flexibility to store all BPS license files in a common location referenced by BPS_LICENSE_PATH, or locally on each machine licensed to run BPS. The default license directory is <BPS Install>license. Please refer to the README in <BPS Install>/license for information on manually setting BPS license paths. 

 

Failure to detect a valid license file, or finding a license that has already expired, will cause an error and description of the license state to be displayed in the MATLAB® console.  Please contact your NI sales representative regarding any license-related issues.

 

Starting BPS on Windows

 

After BPS has been setup the user can now use the BPS tools when running MATLAB® and Simulink®. To load BPS the user must first run System Generator provided by Xilinx which will start MATLAB® tools with System Generator. After MATLAB® has opened the user can then run the startup.m script provided with the BPS installation which will then setup the MATLAB® environment to include BPS. The user can now call BPS from MATLAB® to open the BPS prompt and build a design.

 

A user can verify MATLAB® has the correct environment set up by running the following commands from the MATLAB® console:

 

which bps

which sysgen

 

MATLAB® should report back a non empty path if the user has setup their environment correctly. If which sysgen reports an empty path the user should double check they opened System Generator and not MATLAB®. If which bps reports an empty path the user should double check that they called the startup.m script that was provided with the BPS installation.

 

Starting BPS on Linux

 

Depending on how the user has installed the Vivado and MATLAB® tools, the user may have to manually modify their environment before they can call the System Generator tools.

 

If the PATH environment variable does not contain the correct paths for the tools the following bash commands will start up System Generator with the correct environment:

 

source <Vivado installation path>/settings64.sh

export PATH=$PATH:<Matlab installation path>/bin

sysgen

 

After MATLAB® has opened the user can then run the startup.m script provided with the BPS installation which will then setup the MATLAB® environment to include BPS. The user can now call BPS from MATLAB® to open the BPS prompt and build a design.

 

A user can verify MATLAB® has the correct environment set up by running the following commands from the MATLAB® console:

 

which bps

which sysgen

 

MATLAB® should report back a non empty path if the user has setup their environment correctly. If which sysgen reports an empty path the user should double check they opened System Generator and not MATLAB® and that their PATH variable includes the correct paths for the tools. If which bps reports an empty path the user should double check that they called the startup.m script that was provided with the BPS installation.

 

Additional Assistance

 

If you encounter any problems while downloading or installing BPS, please email bps.support@ni.com to request assistance.

 

MATLAB® and Simulink® are registered trademarks of The Mathworks, Inc. All other trademarks are the property of their respective owners.

0 Kudos
Message 1 of 3
(4,077 Views)

Hello,

 

Does the new version of BPS work with other versions of MATLAB and Vivado besides 2015b and 2015.4 respectively?

0 Kudos
Message 2 of 3
(3,913 Views)

The new BPS still works with Matlab2015b and Vivado2015.4

0 Kudos
Message 3 of 3
(3,878 Views)