Get Simulation Cycles

Get 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

Get Simulation Cycles

cURL

curl --request GET \
  --url https://api.ionworks.com/simulations/{simulation_id}/cycles

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

simulation_id · string · required

Response

200

application/json

Successful Response