Get Simulation Cycles
curl --request GET \
--url https://api.ionworks.com/simulations/{simulation_id}/cyclesimport requests
url = "https://api.ionworks.com/simulations/{simulation_id}/cycles"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/simulations/{simulation_id}/cycles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/simulations/{simulation_id}/cycles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simulations/{simulation_id}/cycles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/simulations/{simulation_id}/cycles")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simulations/{simulation_id}/cycles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Simulations
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 --request GET \
--url https://api.ionworks.com/simulations/{simulation_id}/cyclesimport requests
url = "https://api.ionworks.com/simulations/{simulation_id}/cycles"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/simulations/{simulation_id}/cycles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/simulations/{simulation_id}/cycles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simulations/{simulation_id}/cycles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/simulations/{simulation_id}/cycles")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simulations/{simulation_id}/cycles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Was this page helpful?