API reference¶
Generated from the docstrings in the source, so it cannot drift from the code.
If you are looking for how to do something, start with the tutorials or the how-to guides — this section is for when you already know what you want and need the signature.
Where to look¶
| You want | Look in |
|---|---|
| Load a file, get capacities, save | cellpy — get, CellpyCell |
| The cell object and its frames | Readers |
| Instrument loaders and the plugin contract | Instruments |
| Run a set of cells as one job | Batch |
| Collect a batch into one tidy frame | Collect |
| Plotting, helpers, ICA | Utils |
| Configuration and column schemas | Parameters and config |
Stability¶
The surfaces documented here follow the deprecation cadence in
Deprecations: anything introduced as a shim in
2.0 is removed in 2.1, and anything prefixed with _ may change without
notice.