API reference for core
modules
The core
module contains the key shared resources and
building blocks used to develop the different component models of the Virtual Ecosystem
and then to configure them, populate them with data and provide logging.
Each of the core sub-modules has its own API reference page:
The
config
submodule covers the definition of formal configuration schema for components and the parsing and validation of TOML configuration documents against those schema.The
logger
configures theLogger
instance used throughout the package.The
grid
submodule covers the definition of the spatial layout to be used in a simulation and provides an interface to the spatial relationships between cells.The
data
submodule provides the central data object used to store data required by the simulation and methods to populate that data object for use in simulations.The
readers
submodule provides functionality to read external data files into a standard internal format.The
axes
submodule provides validation for data to ensure that it is congruent with the model configuration.The
base_model
submodule provides an Abstract Base Class describing the shared API to be used by science models within the Virtual Ecosystem.The
constants
contains the constants that are shared across multiple models.The
utils
contains the utility functions that are used across the Virtual Ecosystem.The
exceptions
submodule defines custom exceptions that are used either in the core module, or across multiple modules.
The core
module itself is only responsible for loading the
configuration schema for the core submodules.