Get Simulation Cycles
Changed onGet cycle-level metrics for a simulation.
Computes metrics like discharge capacity, coulombic efficiency, capacity retention, etc. for each cycle from the steps.parquet file using ionworksdata.cycle_metrics.get_cycle_metrics.
Parameters
simulation_id : str ID of the simulation user_org_client : tuple[str, str | None, AsyncClient] Current user_id, organization_id, and Supabase client simulation_repository : SimulationRepository Repository for simulations table simulation_data_repository : SimulationDataRepository Repository for simulation_data table
Returns
dict Dictionary with cycle metrics as lists, one value per cycle. Keys include: Cycle number, Discharge capacity [A.h], Charge capacity [A.h], Coulombic efficiency, Capacity retention, etc.
Raises
HTTPException 404 if no results found, 500 for computation errors
Request
- Base URLhttps://api.ionworks.com
- URLhttps://api.ionworks.com/simulations/{simulation_id}/cycles
- Authnone declared
Path parameters
Query parameters
Maximum rows of the cycle series
Response
Successful Response
Changes
- breaking
for the
pathrequest parametersimulation_id, the format changed from no format touuid
- breaking