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.37.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ionworks_api-0.37.1.tar.gz | 188.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ionworks_api-0.37.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 407.4 kB
Release files / ionworks_api-0.37.1.tar.gz
| Download URL | ionworks_api-0.37.1.tar.gz |
|---|---|
| Size | 188.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c465b991a40496e2fadf6e8417293375a02fd0374abf19690f10f654b64c2982
|
|
BLAKE2b-256 checksum How to use checksums |
0e1b1c7255baf0e444eaa18fbea613c75e53b6b9bf1b10c8c2e408c1b1c62c8a
|
| 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.37.1-py3-none-any.whl
| Download URL | ionworks_api-0.37.1-py3-none-any.whl |
|---|---|
| Size | 219.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ad7b87ed3488cfaa7553b41336e82050174b07a3d739342ba17fab4154a81679
|
|
BLAKE2b-256 checksum How to use checksums |
dc9bc9abfd052c5c7d9e071eb2a6c2cf702f1ac13fba043d8e01a2f78430b05e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for ionworks-api 0.37.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
