User guide

Welcome to the ampworks user guide. This guide will help you get started with using the software, including a brief introduction to what ampworks is and how to install it. As the package matures you can also expect to find more detailed documentation about the algorithm fundamentals and features of the software.

The ampworks package is designed with simplicity and ease of use in mind. It centers around the Dataset class, which provides a consistent column naming convention, data types, and a set of methods for downstream analysis. It provides reading capabilities that allow users to easily map their battery data from any cycler and format into one that is compatible with ampworks functions. Once data is in the Dataset format, users can take advantage of the various visualization and analysis tools provided by the package to gain insights into their battery data.