Skip to content

epymorph.kit

A convenient star-import for the most-commonly-used features in epymorph.

Most of the included symbols are classes or functions which you can find by searching their names. The three exceptions are init, ipm, and mm which are whole Python modules or packages representing our built-in component libraries.

  • init is the epymorph.initializer module
  • ipm is the epymorph.data.ipm package
  • mm is the epymorph.data.mm package

Included this way, for instance, you can instantiate the built-in SIRS IPM like:

1
my_ipm = ipm.SIRS()

__all__ module-attribute 

__all__ = [
    "init",
    "ipm",
    "mm",
    "CompartmentModel",
    "ModelSymbols",
    "TransitionDef",
    "compartment",
    "edge",
    "fork",
    "BIRTH",
    "DEATH",
    "SingleStrataRUME",
    "MultiStrataRUME",
    "MultiStrataRUMEBuilder",
    "GPM",
    "MultiStrataModelSymbols",
    "BasicSimulator",
    "sim_messaging",
    "default_rng",
    "CustomScope",
    "StateScope",
    "CountyScope",
    "TractScope",
    "BlockGroupScope",
    "ParamFunction",
    "ParamFunctionNumpy",
    "ParamFunctionScalar",
    "ParamFunctionTime",
    "ParamFunctionNode",
    "ParamFunctionNodeAndNode",
    "ParamFunctionNodeAndCompartment",
    "ParamFunctionTimeAndNode",
    "TimeFrame",
    "AttributeDef",
    "Shapes",
    "SimDType",
    "CentroidType",
    "CentroidDType",
]

When you do from epymorph.kit import * you get all of these symbols.