Which package do I need?

Ionworks is one platform with two front doors: Ionworks Studio in the browser, and the ionworks Python package for scripting it.

Start here

If you want to…	Use
Click through cells, measurements, and simulations without writing code	Ionworks Studio — nothing to install
Script the platform: upload data, run simulations, submit pipelines, fetch results	`ionworks.api`
Describe a pipeline — what to fit, against which data, with which optimizer	`ionworks.pipeline`
Convert raw cycler files into the Ionworks data format on your own machine	`ionworks.data`

Every subpackage comes with one install:

pip install ionworks

import ionworks as iw

client = iw.api.Client()  # reads IONWORKS_API_KEY from the environment

Most scripted workflows use ionworks.pipeline and ionworks.api together: ionworks.pipeline describes the pipeline, ionworks.api submits it and collects the result.

The subpackages in full

Subpackage	Reach for it when
`ionworks.api`	You are automating the platform from Python — data upload, simulations, pipeline submission, results.
`ionworks.pipeline`	You are building a pipeline config: `iw.pipeline.Pipeline`, `iw.pipeline.DataFit`, objectives, costs, optimizers.
`ionworks.data`	You have raw cycler exports (Arbin, Maccor, Basytec, Neware, Digatron, …) to convert locally before upload.
`ionworks.util`	You want the small file and path helpers the examples use.

Upgrading from the old packages. ionworks replaces ionworks-api, ionworks-schema, ionworksdata and iwutil, which receive no further releases. ionworks and ionworks-api cannot share an environment, and from ionworks import Ionworks becomes iw.api.Client(). See the migration guide.

Next steps

Quickstart

Get from nothing to a first result.

Python API client

Install, authenticate, and meet the sub-clients.

Pipelines

Describe fits and validations with ionworks.pipeline.

Preparing data

Convert raw cycler files with ionworks.data.

Get Started

Quickstarts

Core Concepts

Operate

Data

Build

Simulate

Optimize

Start here

The subpackages in full

Next steps

Quickstart

Python API client

Pipelines

Preparing data

​Start here

​The subpackages in full

​Next steps

Quickstart

Python API client

Pipelines

Preparing data

Start here

The subpackages in full

Next steps