Upgrading the Python and MATLAB SDK

  • Updated

Knowing which version of the Flywheel SDK you are using allows you to know exactly which features are available to you and allows you to verify that you are using a supported version.

This article explains how to check the version and how to upgrade your Python or MATLAB SDK. 

 

Python SDK

Follow the steps below to use pip to confirm and upgrade your Python SDK.

Check version

  1. Open Terminal.

  2. Enter the following command:

    pip show flywheel-sdk

  3. You'll see the following response:

    Name: flywheel-sdk
Version: 9.0.2
Summary: Flywheel SDK
Home-page: UNKNOWN
Author: None
Author-email: support@flywheel.io
License: MIT
Location: /Library/Python/2.7/site-packages
Requires: requests, certifi, requests-toolbelt, urllib3, 
    python-dateutil, six
Required-by: 

Upgrade your SDK version

  1. Open Terminal.

  2. Enter the following command:

    pip install flywheel-sdk --upgrade

  3. You will see the following response if you are not using the latest version of the SDK:

    Collecting flywheel-sdk
  Downloading https://files.pythonhosted.org/packages/6e/d8/ec0b700a2a9a646e3bf2c864f319ff804f30b26423a9f8b5d82bfee2948d/flywheel_sdk-10.7.1-py2.py3-none-any.whl (651kB)
     |████████████████████████████████| 655kB 2.2MB/s 
Requirement already satisfied, skipping upgrade: requests>=2.18.4 in /Library/Python/2.7/site-packages (from flywheel-sdk) (2.22.0)
Requirement already satisfied, skipping upgrade: certifi in /Library/Python/2.7/site-packages (from flywheel-sdk) (2019.6.16)
Requirement already satisfied, skipping upgrade: requests-toolbelt in /Library/Python/2.7/site-packages (from flywheel-sdk) (0.9.1)
Requirement already satisfied, skipping upgrade: urllib3>=1.15 in /Library/Python/2.7/site-packages (from flywheel-sdk) (1.25.3)
Requirement already satisfied, skipping upgrade: python-dateutil in /Library/Python/2.7/site-packages (from flywheel-sdk) (2.8.0)
Requirement already satisfied, skipping upgrade: six>=1.10 in /Library/Python/2.7/site-packages (from flywheel-sdk) (1.12.0)
Requirement already satisfied, skipping upgrade: chardet<3.1.0,>=3.0.2 in /Library/Python/2.7/site-packages (from requests>=2.18.4->flywheel-sdk) (3.0.4)
Requirement already satisfied, skipping upgrade: idna<2.9,>=2.5 in /Library/Python/2.7/site-packages (from requests>=2.18.4->flywheel-sdk) (2.8)
Installing collected packages: flywheel-sdk
  Found existing installation: flywheel-sdk 9.0.2
    Uninstalling flywheel-sdk-9.0.2:
      Successfully uninstalled flywheel-sdk-9.0.2
Successfully installed flywheel-sdk-10.7.1

MATLAB SDK

Follow the directions below to use MATLAB to check your SDK version or upgrade.

Check your version

  1. Open MATLAB, and go to the Command Window.

  2. To see your version, use:

    flywheel.Flywheel.SDK_VERSION

Upgrade your SDK version

Depending on how you installed the Flywheel SDK in MATLAB, there are 2 ways to upgrade your SDK version.

Option 1: Add Flywheel SDK to your Matlab path

Adding the SDK to your path can be done in two ways, either modify your startup file or change your path definitions via the pathdef tool. 

To use your startup file, at the command prompt type:

edit startup

then add the following lines to your startup file, being sure to modify the fw_sdk_path variable to point to the location of where you downloaded and unzipped the SDK archive. 

fw_sdk_path = '</path/to/flywheel-sdk/>';
addpath(genpath(fw_sdk_path));
javaaddpath(fullfile(fw_sdk_path,'api','rest-client.jar'));

To use the Path Editor:

  1. On the Home tab, in the Environment section, click Set Path.
    The Set Path dialog box appears.

  2. Go to the your flywheel-sdk folder.

    MATLABSetPath.png

  3. Click Remove.

  4. Download the latest version of the SDK that is the closest match to your current Flywheel version (note that not all Flywheel releases have a matching SDK version):
    Download 14.6.1
    Download 14.6.3
    Download 14.6.6
    Download 15.8.0

  5. In the Set Path screen in MATLAB, click Add with Subfolders, and add the newer version of the Flywheel SDK.
    See Mathwork's documentation for more information about setting paths in MATLAB

Option 2:The MATLAB toolbox

If you manage your Flywheel SDK by using the toolbox, follow these steps to upgrade your version:

  1. In MATLAB, click Add Ons.

  2. Click Manage Add on.

  3. Navigate to flywheel-sdk

    flywheel-sdkMATLABToolbox.png

  4. Click the Options menu add_ons_options_menu.png.

  5. Select Uninstall.

  6. Download the version of the MATLAB toolbox that is the closest match to your Flywheel version (note that not all Flywheel releases have a matching SDK version):
    Download 14.6.1
    Download 14.6.3
    Download 14.6.6
    Download 15.8.0

  7. Add the Flywheel SDK. 
    See Mathwork's documentation for more information about managing Add Ons in MATLAB.