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.mdfor 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()
1 maintainer
Metadata
1 maintainer
Release files for ionworks-api 0.36.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ionworks_api-0.36.0.tar.gz | 180.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ionworks_api-0.36.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 391.3 kB
Release files / ionworks_api-0.36.0.tar.gz
| Download URL | ionworks_api-0.36.0.tar.gz |
|---|---|
| Size | 180.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
87a59de269e7499e1b982421a99b4899652210e854ac93d0165fb56fa3424fd1
|
|
BLAKE2b-256 checksum How to use checksums |
fe875e378371e16c4543ca68cfea3a2bad8e6d3ac950c4a6d118c0e65b4f5048
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ionworks_api-0.36.0-py3-none-any.whl
| Download URL | ionworks_api-0.36.0-py3-none-any.whl |
|---|---|
| Size | 210.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7e0387833fe5ec68c90a9e4a6eb0d27e3d4f965cf6916642c596ded56214aa0
|
|
BLAKE2b-256 checksum How to use checksums |
b391e272b43da43cd3ac1fe2964e37356691ef2a9e9d91268cb5c64d210395ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
