Pennsieve

The Pennsieve Documentation Hub

Welcome to the Pennsieve Documentation Hub. Here, you will find all documentation about the Pennsieve Platform, as well as our API-Reference and Client Tools. You can even let us know how to improve our documentation, so feel free to add suggestions!

Guides    API Reference

Installing the Pennsieve Agent

Command Line Interface and background agent for interacting with the platform

Overview

The Blackfynn Agent is an application that runs natively on Mac, Linux and Windows and is required for optimal performance of the MATLAB and Python clients. In addition, the Blackfynn Agent provides a Command Line Interface (CLI) for the Blackfynn platform.

The Github for the Pennsieve client can be found here: https://github.com/Pennsieve/agent and you can download the latest version of the Agent by either navigating to the latest release on Github or download the installer directly from this document.

Installing the Agent

Windows

Download and install Pennsieve-0.3.5-x86_64.msi

  • The Pennsieve home directory will be created in C:\Users\<user>\.pennsieve.
  • The agent executable will be installed to C:\Program Files\Pennsieve\pennsieve.exe.
  • The agent will automatically be added to your path.

macOS

Download and install pennsieve-0.3.5.pkg

  • The Pennsieve home directory will be created in /Users/<user>/.pennsieve.
  • The agent executable will be installed to `/usr/local/opt/pennsieve/bin/pennsieve``.
  • Add the Pennsieve agent to your path by running the following in your terminal:
echo 'export PATH="/usr/local/opt/pennsieve/bin:$PATH"' >> ~/.profile && source ~/.profile

Debian Linux

Download and install pennsieve_0.3.5_amd64.deb

  • The Pennsieve home directory will be created in /home/<user>/.pennsieve.
  • The agent executable will be installed to /opt/pennsieve/bin/pennsieve.
  • Add the Pennsieve agent to your path by running the following in your terminal:
export PATH="/opt/pennsieve/bin:$PATH"' >> ~/.profile && source ~/.profile

Running the Pennsieve Agent

To run the Pennsieve Agent, or use the CLI tools, open a terminal and run:

pennsieve version

For a full list of commands and CLI documentation, run:

pennsieve --help

Updated about a month ago



Installing the Pennsieve Agent


Command Line Interface and background agent for interacting with the platform

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.