API documentation

Release:

0.0.0

Date:

Nov 08, 2024

This reference manual details functions, modules, and objects included in ionworkspipeline, describing what they are and what they do. For a high-level introduction, see the user guide

• Calculations
  • Calculation
  • Capacity Calculations
  • Cyclable Lithium Calculations
  • Electrode State of Health Calculations
  • Geometric Calculations
  • Initial Concentration Calculations
  • Microstructure Calculations
  • MSMR function
  • Open Circuit Potential Interpolants
  • Particle Diffusivity
• Data Fits
  • Data Fits
  • Cost Functions
  • Objectives
  • Optimizers
  • Parameter
  • Result
  • Callbacks
  • Custom Parameters
  • Data utilities
• Direct Entries
  • DirectEntry
  • from_json()
  • Exchange-current density functions
  • Particle Diffusivity Functions
  • Thermal Direct Entries
  • Electrolyte Direct Entries
  • Miscellaneous Direct Entries
• Library
  • Library
• Pipeline
  • Pipeline
• Pipelines
  • Half-Cell Pipelines
• Preprocessing functions
  • PiecewiseLinearTimeseries
  • pulse_data_to_ocp()
  • sort_capacity_and_ocp()
  • remove_duplicate_ocp()
  • remove_ocp_extremes()
• Utilities
  • subplots_autolayout()
  • export_python_script()
  • save_csv()
  • save_json()
  • save_fig()
• Workflows
  • fit_plot_save()
  • fit_plot_save()
  • fit_plot_save()
  • get_objective_and_callbacks()
  • process_filename()
  • plot()