SDK Installation Guide

To access the full power of the TripleBlind platform, download and install the SDK. To download the SDK, click on the Download SDK link in the upper-right corner of the Documentation. This downloads a .zip file to your system.

ℹ️Before using the SDK, an Access Point must be installed for your organization. See the Access Point Installation or contact your IT department to have them do so.

ℹ️It is possible for the Access Point administrator to host the SDK on behalf of the users. To learn more about this option, refer to the Hosted Jupyter Notebook SDK section in the Access Point Administration.

Prerequisites

The SDK and all examples use Python 3 (version 3.7+ is supported on all modern operating systems). The R programming language is also supported via the Reticulate package. To ensure the designed behavior and to avoid conflicts, we highly recommend operating in a Python virtual environment.

The provided installation scripts use the Conda package management system and install Miniconda along with all required libraries. The SDK should also work with other package managers (such as pip), but currently only conda is officially supported.

Supported Operating Systems

The SDK has been validated on modern operating systems.

  • Linux (Ubuntu 18.04+, most modern distros)
  • macOS 10.12.6+
  • Windows 10+ (directly or via WSL2)

Networking

All SDK users will need to have the networking permission (e.g. appropriate firewall settings) to access several domains:

  • The Router web interface. Typically this is “tripleblind.app”, but could be something like “acme.tripleblind.app” if running in an evaluation environment.
  • The Router API. Typically this is “dev.tripleblind.app” but could be something like “devacme.tripleblind.app” if running in an evaluation environment.
  • Your own Access Point.

Install the TripleBlind Python Library

These instructions and all tutorials assume the SDK has been downloaded and unzipped into a folder named ~/tripleblind-sdk. You can safely place the SDK anywhere on your system, just adjust the instructions accordingly.

Mac/Linux installation:

1. Open a terminal window.

2. Change to the directory with the unzipped package. If you don’t already have this:

  • Run: mkdir ~/tripleblind-sdk
  • Run: cd ~/tripleblind-sdk
  • Run: curl -L https://www.tripleblind.app/sdk --output sdk.zip
  • Run: unzip sdk.zip

3. Run: ./install.sh

4. Follow the prompts to complete installation.

Windows installation:

1. Navigate to the folder where you unzipped the package.

2. Double-click on the install.ps1 script (or right click it and choose “Run with PowerShell”).

3. Follow the prompts to complete installation.

Obtain Authentication Token

Once installed, the tripleblind.yaml file in your “tripleblind-sdk” folder will need to be replaced with your specific account credentials. To update follow the instructions below.

1. Visit 🔗My Settings


2. Navigate to the Authentication tab