DandeLiion Client documentation

The DandeLiion client provides a PyBaMM-like python interface to run on a local or remote DandeLiion server instance.

Installation

The DandeLiion client can be installed directly from pypi using pip with the following command:

pip install dandeliion-client

Example

The following code is an example for how to write a python script to run a simulation:

import dandeliion.client as dandeliion
import numpy as np
import matplotlib.pyplot as plt
from pybamm import Experiment

api_url = "https://server-address"
api_key = "some_hash"
simulator = dandeliion.Simulator(api_url, api_key)

# BPX file or already read-in valid BPX as dict or BPX object
params = 'example_bpx.json'

experiment = Experiment(
  [
      (
          "Discharge at 10 A for 100 seconds",
          "Rest for 10 seconds",
          "Charge at 6 A for 100 seconds",
      )
  ]
  * 2,
  period="1 second",
)

extra_params = {}
extra_params['Mesh'] = {"x_n": 16, "x_s": 8, "x_p": 16, "r_n": 16, "r_p": 16}
extra_params['Initial SOC'] = 1.0

solution = dandeliion.solve(
      simulator=simulator,
      params=params,
      experiment=experiment,
      extra_params=extra_params,
)

# Print all available keys in the solution object
for key in sorted(solution.keys()):
  print(key)

# Print the final values of time, voltage, and temperature
print(f"Final time [s]: {solution['Time [s]'][-1]}")
print(f"Final voltage [V]: {solution['Voltage [V]'][-1]}")
print(f"Final temperature [K]: {solution['Temperature [K]'][-1]}")

# Plot current and voltage vs time
fig, axs = plt.subplots(2, 1, figsize=(10, 8))
axs[0].plot(solution["Time [s]"], solution["Current [A]"], label="DandeLiion")
axs[0].set_xlabel("time [s]")
axs[0].set_title("Current [A]")
axs[0].legend()
axs[1].plot(solution["Time [s]"], solution["Voltage [V]"], label="DandeLiion")
axs[1].set_xlabel("time [s]")
axs[1].set_title("Voltage [V]")
axs[1].legend()
plt.tight_layout()
plt.show()

# Concentration in the electrolyte vs `x` at the last time step
plt.plot(
    solution["Electrolyte x-coordinate [m]"] * 1e6,
    solution["Electrolyte concentration [mol.m-3]"][-1],
    label="Dandeliion",
)
plt.xlabel(r"x [$\mu$m]")
plt.title("Electrolyte conc. (end of experiment) [mol.m-3]")
plt.legend()
plt.show()

# If the user needs the solution at the `t_eval` times, the following code can be used (works only correctly on columns with timeline data)
# This is a linear interpolation with constant extrapolation
solution["Voltage [V]"](t=t_eval)

where the following classes & methods have been used:

`dandeliion.client.Simulator`	Simulator class that stores authentication details and deals with job submission and result acquisition
`dandeliion.client.Solution`	Dictionary-style class for the solutions of a simulation run returned by `solve()`
`dandeliion.client.solve`	Method for submitting/running a DandeLiion simulation.