Misc

Functions

catch_module_not_found(function)

A decorator that wraps the passed in function and catches ModuleNotFound exception.

end_all([globs])

Finish defining externally accessible objects.

flat_list(input_list)

Given a list of nested lists of arbitrary depth, returns a single level or 'flat' list.

ignore_warnings([warning])

Decorator for catching warnings.

is_symmetric(a[, rtol])

Is a a symmetric matrix?

is_valid_propname(propname)

Checks if propname is a valid OpenPNM propname, i.e. starts with 'pore.' or 'throat.'.

methods_to_table(obj)

Brief explanation of 'methods_to_table'

models_to_table(obj[, params])

Converts a ModelsDict object to a ReST compatible table

prettify_logger_message(msg)

Prettifies logger messages by breaking them up into multi lines

remove_prop_deep(obj, propname)

Hierarchically deletes the given propname and its children

sanitize_dict(input_dict)

Given a nested dictionary, ensures that all nested dicts are normal Python dicts.

start_all([globs])

Start defining externally accessible objects.

tic()

Homemade version of matlab tic and toc function, tic starts or resets the clock, toc reports the time since the last call of tic.

toc([quiet])

Homemade version of matlab tic and toc function, tic starts or resets the clock, toc reports the time since the last call of tic.

unique_list(input_list)

For a given list (of points) remove any duplicates

Classes

Docorator

Brief explanation of 'Docorator'

DocstringProcessor

Class that is intended to process docstrings.

HealthDict

This class adds a 'health' check to a standard dictionary.

NestedDict

Brief explanation of 'NestedDict'

OrderedDict

Dictionary that remembers insertion order

PrintableDict

Simple subclass of dict that has nicer printing.

PrintableList

Simple subclass of list that has nice printing.

SubDict

Brief explanation of 'SubDict'