Introduction

Overview of Ionworks Studio: a web platform for electrochemical modeling, simulation, and optimization of lithium-ion battery cells

Welcome to Ionworks Studio, the web platform for electrochemical modeling and simulation of battery cells. Our goal is to provide a powerful and collaborative environment for battery engineers and researchers to design, analyze, and optimize battery performance.

This documentation will guide you through the core features and concepts of Ionworks Studio.

Getting Started

Ready to dive in? Our Quickstart guide will walk you through the process of running your first simulation.

What’s New

Changelog

See the latest product updates and announcements.

Core Concepts

To get started, it’s helpful to understand the key concepts that form the foundation of Ionworks Studio.

Organizations

Manage your team and collaborate on battery research.

Projects

Organize your research into high-level initiatives.

Cells

Define the fundamental properties of your battery cells.

Data

Upload and visualize your experimental battery cycling data.

Data Overview

Understand how experimental data is managed in Ionworks Studio.

Data Format

Learn about the required file formats and data structure.

Uploading data

Upload experimental data via the Python API.

Visualizing Data

Explore interactive data visualization and filtering.

Build

Create the building blocks for your simulations.

Models

Create electrochemical models to power your simulations.

Parameterized Models

Combine models with parameters to create ready-to-run simulation engines.

Simulate

Run simulations and analyze battery performance.

Studies

Run focused investigations with simulations and analysis.

Simulations

Run and visualize battery simulations.

Protocols

Create protocols or use built-in experiment templates.

Universal Cycler Protocol

Define complex experimental cycles using a universal language.

Optimize

Automatically find optimal parameters for your battery designs.

Optimization Overview

Learn how optimization works in Ionworks Studio.

Optimization Templates

Pre-configured templates for common optimization scenarios.

Running an Optimization

Step-by-step guide to running your first optimization.

Dive Deeper with our Python Libraries

For users who want to programmatically interact with Ionworks Studio and develop their own parameterization workflows, we offer powerful Python libraries.

Ionworks Python API

A Python client for interacting with the Ionworks API.

Ionworks Battery Parameter Pipeline

A library for parameterizing electrochemical battery models from experimental data.

Ionworks Data Processing

A library for processing experimental data into a common format (BaSyTec, Maccor, Biologic, etc.) and loading processed data for use in other Ionworks software.

PyBaMM

An open-source battery modeling framework co-developed by the Ionworks team, offering powerful tools for electrochemical modeling and simulation.