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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ionworks_api-0.21.0.tar.gz.
File metadata
- Download URL: ionworks_api-0.21.0.tar.gz
- Upload date:
- Size: 122.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce6c05867ab7d8dd3ac93672a264eefabb95c8b1419c8d7bc1b241b2301e4208
|
|
| MD5 |
1f1e4d3456bef33f09f4151edd0186fe
|
|
| BLAKE2b-256 |
f58a3a7fe6b8c66d7448e49a2a5e474d7f049005e99db1121150591b860e0320
|
File details
Details for the file ionworks_api-0.21.0-py3-none-any.whl.
File metadata
- Download URL: ionworks_api-0.21.0-py3-none-any.whl
- Upload date:
- Size: 147.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b11914c0bb04ab308afb5abc48158c4ed2e05879625875541239d8e49faedcae
|
|
| MD5 |
27ce50c61c71708aee008fa1a70e5763
|
|
| BLAKE2b-256 |
daeea1c9aafb526834889423c6c51b7c9330a67cf0aad502a2307cfb66c79f0e
|
