brainmass.list_models

Contents

brainmass.list_models#

brainmass.list_models()[source]#

Return the catalogue of public neural-mass models.

Returns:

One typed record per user-facing model, giving its name, category, number of state variables, and a one-line typical use case.

Return type:

List[ModelInfo]

See also

brainmass.list_models.to_table

a plain-text rendering of the same data.

Examples

>>> import brainmass
>>> models = brainmass.list_models()
>>> {m.name for m in models} >= {'HopfStep', 'JansenRitStep'}
True
>>> next(m for m in models if m.name == 'JansenRitStep').n_state_vars
6
Contents