Artifact Interface

This module provides an interface to the ArtifactManager.

class vivarium.engine.framework.artifact.interface.ArtifactInterface(manager)

The builder interface for accessing a data artifact.

Parameters:

manager (ArtifactManager)

load(entity_key, **column_filters)

Loads data associated with a formatted entity key.

The provided entity key must be of the form {entity_type}.{measure} or {entity_type}.{entity_name}.{measure}.

Here entity_type denotes the kind of entity being described. Examples include cause, risk, population, and covariates.

The entity_name is the name of the specific entity. For example, if we had entity_type as cause, we might have entity_name as diarrheal_diseases or ischemic_heart_disease.

Finally, measure is the name of the quantity the data describes. Examples of measures are incidence, disability_weight, relative_risk, and cost.

Return type:

Any

Parameters:

• entity_key (str) – The key associated with the expected data.

• column_filters (int | str | Sequence[int | str]) – Filters that subset the data by a categorical column and then remove the column from the raw data. They are supplied as keyword arguments to the load method in the form “column=value”.

Returns:

The data associated with the given key filtered down to the requested subset.