ionworks-api 0.14.0

Python client for interacting with the Ionworks API

Ionworks API Client

This is a read-only mirror. The source of truth is a private repo.

A Python client for interacting with the Ionworks API.

Installation

pip install ionworks-api

Quick start

from ionworks import Ionworks

# Initialize client (uses IONWORKS_API_KEY from environment/.env file)
client = Ionworks()

# or provide credentials directly
client = Ionworks(api_key="your_key")

Get your API key from the Ionworks account settings.

Sub-clients

The client exposes domain-specific sub-clients:

Sub-client	Access	Description
Projects	client.project	Create, list, update, delete projects
Models	client.model	Create, list, update, delete models
Parameterized models	client.parameterized_model	List, create, get parameter values
Studies	client.study	Manage studies and assign simulations/measurements
Protocols	client.protocol	Validate UCP protocols
Simulations	client.simulation	Run simulations and retrieve results
Pipelines	client.pipeline	Submit parameterization pipelines
Optimizations	client.optimization	Run design optimizations
Cell specifications	client.cell_spec	Manage cell specifications
Cell instances	client.cell_instance	Manage cell instances
Cell measurements	client.cell_measurement	Upload and retrieve measurement data
Jobs	client.job	Monitor and cancel background jobs

Documentation

• Guides and tutorials: docs.ionworks.com
• API reference: api.docs.ionworks.com
• Changelog: CHANGELOG.md for this package; docs.ionworks.com/changelog for the full Ionworks platform changelog.

Environment variables

Variable	Required	Default	Description
IONWORKS_API_KEY	Yes	—	API key from account settings
IONWORKS_API_URL	No	https://api.ionworks.com	API base URL
IONWORKS_PROJECT_ID	For pipelines / project-scoped calls	—	Default project ID from your project settings page. Used as the default project_id on the client. (PROJECT_ID is accepted as a deprecated fallback.)

The client does not load .env files on its own. If your variables live in a .env, call load_dotenv() yourself before constructing the client:

from dotenv import load_dotenv
load_dotenv()

from ionworks import Ionworks
client = Ionworks()