epymorph.kit

As a convenience feature, epymorph includes the epymorph.kit package which you can use in a star-import.

from epymorph.kit import *

# and so onward
#   to big things
#     from such small beginnings

Like a “starter kit”, this is designed to give you quick acccess to the most-commonly-used classes and methods in epymorph.

epymorph.kit includes:

• init: a package containing pre-built Initializers
• ipm: a package containing pre-built IPMs
• mm: a package containing pre-built Movement Models
• CompartmentModel: for defining your own IPM (with the following)
• ModelSymbols
• TransitionDef
• compartment
• edge
• fork
• BIRTH
• DEATH
• SingleStrataRUME: constructing RUMEs (with the following)
• MultiStrataRUME
• MultiStrataRUMEBuilder
• GPM
• MultiStrataModelSymbols
• BasicSimulator: running forward simulations
• sim_messaging: producing pretty progress messages during simulation runs
• default_rng: the customizing RNG behavior
• CustomScope: for specifying geo scopes (with the following)
• StateScope
• CountyScope
• TractScope
• BlockGroupScope
• ParamFunction: for defining your own parameter functions (with the following)
• ParamFunctionNumpy
• ParamFunctionScalar
• ParamFunctionTime
• ParamFunctionNode
• ParamFunctionNodeAndNode
• ParamFunctionNodeAndCompartment
• ParamFunctionTimeAndNode
• TimeFrame: for specifying time frames
• AttributeDef: for specifying data attribute requirements
• Shapes: for specifying data attribute shapes
• SimDType: the numpy dtype used for simulation state variables
• CentroidDType: the numpy structured type definition for centroid values
• CentroidType: like CentroidDType but adapted for use in AttributeDefs