ensembler.util package

Submodules

ensembler.util.basic_class module

Module: basic_class

This file is giving the basic scaffold for saving & loading any Ensembler class with pickle.

class ensembler.util.basic_class._baseClass

Bases: object

This class is a scaffold, containing functionality all classes should have.

classmethod load(path: Union[str, _io.FileIO] = None) → object

This method stores the Class as binary obj to a given path or fileBuffer.

name: str = 'Unknown'

save(path: Union[str, _io.FileIO] = None) → str

This method stores the Class as binary obj to a given path or fileBuffer.

property verbose

ensembler.util.basic_class.notImplementedERR()

ensembler.util.dataStructure module

Module: dataStructure

This module contains all needed data Structures for the project.

ensembler.util.ensemblerTypes module

This file provides ensembler types, that are used to annotate and enforce certain types throughout the ensembler package.

ensembler.util.ensemblerTypes.ensembleCls

from ensembler.potentials._baseclasses import _potentialCls potential = TypeVar(“potential”, bound=_potentialCls)

#define here dummy type, so it is useable in sub classes system = TypeVar(“system”) #dummyDef for samplers

from ensembler.conditions._conditions import _conditionCls condition = TypeVar(“condition”, bound=_conditionCls)

from ensembler.samplers._basicIntegrators import _integratorCls samplers = TypeVar(“samplers”, bound=_integratorCls)

from ensembler.system.basic_system import system system = TypeVar(“system”, bound=system)

alias of TypeVar(‘ensemble’)

Module contents

utils contains a lot of different useful things (e.g. data structures, typings).