Utility functions

pybamm.get_infinite_nested_dict()

Return a dictionary that allows infinite nesting without having to define level by level.

See: https://stackoverflow.com/questions/651794/whats-the-best-way-to-initialize-a-dict-of-dicts-in-python/652226#652226

Example

>>> import pybamm
>>> d = pybamm.get_infinite_nested_dict()
>>> d["a"] = 1
>>> d["a"]
1
>>> d["b"]["c"]["d"] = 2
>>> d["b"]["c"] == {"d": 2}
True

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.rmse(x, y)

Calculate the root-mean-square-error between two vectors x and y, ignoring NaNs

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_function(filename)

Load a python function from an absolute or relative path using importlib. Example - pybamm.load_function(“pybamm/input/example.py”)

Parameters

filename (str) – The path of the file containing the function.

Returns

The python function loaded from the file.

Return type

function

pybamm.load(filename)

Load a saved object

pybamm.get_parameters_filepath(path)

Returns path if it exists in current working dir, otherwise get it from package dir

pybamm.have_julia()

Checks whether the Julia programming language has been installed

pybamm.have_jax()

Check if jax and jaxlib are installed with the correct versions

pybamm.is_jax_compatible()

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