Metadata-Version: 2.4
Name: ionworksdata
Version: 0.6.7
Summary: Data processing for Ionworks software.
Project-URL: Homepage, https://ionworks.com
Project-URL: Documentation, https://packages.docs.ionworks.com/ionworksdata/
Project-URL: Repository, https://github.com/ionworks/ionworksdata
License: MIT License
        
        Copyright (c) 2026 Ionworks Technologies Inc
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: fastexcel>=0.19.0
Requires-Dist: ionworks-api>=0.2.0
Requires-Dist: iwutil>=0.4.0
Requires-Dist: matplotlib>=3.8
Requires-Dist: numpy<2,>=1.26
Requires-Dist: pandas<3,>=2.0
Requires-Dist: polars-lts-cpu>=1.33.1
Requires-Dist: pybamm>=25.12.2
Requires-Dist: scipy>=1.14.0
Provides-Extra: dev
Requires-Dist: openpyxl; extra == 'dev'
Requires-Dist: pytest-cov>=7.0; extra == 'dev'
Requires-Dist: pytest>=9.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: myst-nb; extra == 'docs'
Requires-Dist: pydata-sphinx-theme; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Description-Content-Type: text/markdown

# Ionworks Data Processing

> **This is a read-only mirror.** The source of truth is a private repo.

A library for processing experimental battery data into the common format used across Ionworks software. `ionworksdata` reads files from common battery cyclers (BaSyTec, BioLogic, Maccor, Neware, Novonix, Repower, generic CSV, BDF), normalizes units and sign conventions, and summarizes cycling data into step- and cycle-level tables.

## Installation

```bash
pip install ionworksdata
```

## Quick example

```python
import ionworksdata as iwd

# Reader is auto-detected from the file
data = iwd.read.time_series("path/to/file.mpt")
```

## Documentation

- **Preparing data for Ionworks Studio**: [docs.ionworks.com/data/preparing-data](https://docs.ionworks.com/data/preparing-data) — supported cyclers, custom column mappings, BDF, and troubleshooting.
- **API reference**: [data.docs.ionworks.com](https://data.docs.ionworks.com/) — complete reference for `read`, `write`, `transform`, `steps`, and `load`.
- **Changelog**: [docs.ionworks.com/changelog](https://docs.ionworks.com/changelog) — release notes across the platform and Python packages.

## Reporting issues

If a cycler file doesn't process correctly, please [open an issue](https://github.com/ionworks/ionworksdata/issues) with a **minimal working example**:

- **The data file** that reproduces the problem (anonymize it first if it contains anything sensitive — trimming to the smallest excerpt that still reproduces is ideal).
- **What you tried** — the exact `ionworksdata` call and any options you used.
- **The full error or incorrect output** you got.

By attaching a data file you grant us permission to use it in our regression test suite so the fix stays fixed. If you can't share the file under those terms, please include the smallest possible synthetic reproducer instead.
