Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide will walk you through the essential steps to get up and running with Ionworks Studio. We’ll create a new project, a cell, a parameterized model, a study, and run a basic simulation.

​
Step-by-Step Guide

We create a default Project for you to get started.
  1. Navigate to the Projects page from the main menu.
  2. Click “Default Project” to go to the default project.
Now, let’s define the cell you want to work with within your new project. A Cell Specification is the blueprint for your cell.
  1. Navigate to the Cells page.
  2. Click “New Cell”.
  3. Fill in the required properties:
    • Name: A descriptive name, e.g., “My First NMC Cell”.
    • Chemistry: e.g., “NMC/Graphite”.
    • Nominal Capacity: e.g., 5 Ah.
    • Voltage Limits: e.g., 2.5 V (lower) and 4.2 V (upper).
  4. Click “Create” to save it.
Next, we need a Parameterized Model to describe the cell’s electrochemical behavior. A parameterized model combines a Model (mathematical framework) with specific parameters.
  1. Navigate to the Parameterized Models page.
  2. Click “Create Parameterized Model”.
  3. In the creation wizard, select the Cell Specification you just created.
  4. Select a Model to use. For this quickstart, you can use a system model like “SPM (Full Cell)” which is available to all users.
  5. For parameters, let’s start with a pre-defined parameter set. Select “From Library” and choose a suitable starting point (e.g., Chen2020 for your chemistry).
  6. The platform will run a Parameter Validation check. You can review the parameters and see if there are any warnings or errors.
  7. Give your parameterized model a name and click “Create” to finalize it.
A Study lives inside a project and is used for a focused investigation.
  1. Go back to your newly created project.
  2. Inside the project, click “Create Study”.
  3. Give your study a name, e.g., “Cycling Test”.
  4. Click “Create”.
Now we’re ready to run a Simulation within your study.
  1. Inside your study, click the “Run Simulation” button.
  2. Select the Cell Specification and Parameterized Model you created.
  3. Choose a protocol, for example, the “Constant Current Discharge” template.
  4. Configure the experiment parameters. For example, set the C-rate to 2.
  5. Click “Run”. Ionworks Studio will start the simulation.
Once the simulation is complete, the results will appear in your study.
  1. Go back to your study.
  2. You can see your simulation in the Data View table.
  3. Switch to the Visualization View to plot the results.
  4. Click “Add Plot” and configure it to show voltage vs. capacity.
Congratulations! You’ve just run your first simulation in Ionworks Studio.

​
Next Steps

Now that you’ve run a basic simulation, you can explore more advanced features:

Manage Experimental Data

Upload and manage your battery cycling data for visualization and analysis.

Explore Protocols

Create protocols or use built-in experiment templates.

Organize with Studies

Create focused investigations and compare simulation results.

Run Parameter Sweeps

Explore the effect of changing multiple parameters at once.

Refine Your Models

Clone and edit parameterized models to improve their accuracy.

Optimize Parameters

Automatically find optimal parameters for your battery design.

Parameterize with Python

Use our Python library to parameterize models from experimental data.