Utility functions

pybamm.get_git_commit_info()

Get the git commit info for the current PyBaMM version, e.g. v22.8-39-gb25ce8c41 (version 22.8, commit b25ce8c41)

pybamm.root_dir()

return the root directory of the PyBaMM install directory

class pybamm.Timer

Provides accurate timing.

Example

timer = pybamm.Timer() print(timer.time())

reset()

Resets this timer’s start time.

time()

Returns the time (float, in seconds) since this timer was created, or since meth:reset() was last called.

class pybamm.TimerTime(value)

class pybamm.FuzzyDict

copy() → a shallow copy of D

get_best_matches(key)

Get best matches from keys

search(key, print_values=False)

Search dictionary for keys containing ‘key’. If print_values is True, then both the keys and values will be printed. Otherwise just the values will be printed. If no results are found, the best matches are printed.

pybamm.load(filename)

Load a saved object

pybamm.install_jax(arguments=None)

Install compatible versions of jax, jaxlib.

Command Line Interface:

$ pybamm_install_jax

optional arguments:

-h, –help show help message

-f, –force force install compatible versions of jax and jaxlib

pybamm.have_jax()

Check if jax and jaxlib are installed with the correct versions

Returns:

True if jax and jaxlib are installed with the correct versions, False if otherwise

Return type:

bool

pybamm.is_jax_compatible()

Check if the available versions of jax and jaxlib are compatible with PyBaMM

Returns:

True if jax and jaxlib are compatible with PyBaMM, False if otherwise

Return type:

bool