LookupTable Interface

This module provides an interface to the LookupTableManager.

class vivarium.framework.lookup.interface.LookupTableInterface(manager)

The interface to the lookup table management system.

Simulations tend to require a large quantity of data to run. vivarium provides the Lookup Table abstraction to ensure that accurate data can be retrieved when it’s needed.

For more information, see here.

Parameters:

manager (LookupTableManager)

build_table(data, name='', value_columns=None)

Construct a LookupTable from input data.

If the data is a scalar value, this will return a table that when called will return that scalar value for each index entry.

If the data is a pandas DataFrame columns with names in value_columns will be returned directly when the table is called with a population index. The value to return for each index entry will be looked up based on the values at those indices of other columns of the DataFrame in the simulation population. Non-value columns which exist as a pair of the form “some_column_start” and “some_column_end” will be treated as ranges, and the column “some_column” will be interpolated using order 0 (step function) interpolation over that range. Other non-value columns will be treated as exact matches for lookups.

If value_columns is a single string, the returned table will return a pandas.Series when called. If value_columns is a list or tuple of strings, the returned table will return a pandas DataFrame when called. If value_columns is None, it will return a pandas.Series with the name “value”.

Parameters:

• data (LookupTableData) – The source data which will be used to build the resulting Lookup Table.

• name (str) – The name of the table. If not provided, a generic name will be assigned.

• value_columns (list[str] | tuple[str, ...] | str | None) – The name(s) of the column(s) in the data to return when the table is called.

Returns:

LookupTable

Return type:

LookupTable[pd.Series[Any]] | LookupTable[pd.DataFrame]