Skip to main content
Welcome to the Poelis Python SDK documentation. The SDK reads and updates the same products, items, and properties you see in the Poelis web app, from notebooks and scripts. For the Public REST API, go here. New to Poelis? See the user manual Overview and basic concepts before working with the SDK.

​
SDK capabilities

The Python SDK allows you to:
  • Pull Parameters: Read a set of parameters from Poelis into a notebook
  • Generate Reports: Build plots and reports from live engineering data
  • Target a Version: Keep calculations reproducible by reading a specific product version or the baseline
  • Use Live Values: Work from Poelis directly in a notebook or script
  • Call from MATLAB: Use the same package from MATLAB

​
The SDK

The Poelis Python SDK is a Python package for notebooks and scripts:
  • Package: poelis-sdk
  • Authentication: An SDK key bound to the user who created it
  • Navigation: Workspaces, products, items, and properties by readable ID
  • MATLAB: The same package, called through the Poelis MATLAB Toolbox

Quick Start

Install the package, create a client, and read your first property

SDK Keys

Create a user-bound key and store it safely

Browse Your Data

Dot notation, listings, and readable IDs

Product Versions

Read draft, baseline, or a published version

Edit Properties

Write draft values from Python

Notebooks and Scripts

Explore in a notebook, then pin readable IDs in a script

MATLAB Setup

Point MATLAB at a Python environment with poelis-sdk installed

Use Poelis from MATLAB

Read values, target a version, and update the draft