omfpandas.blockmodel.read_blockmodel_attributes

omfpandas.blockmodel.read_blockmodel_attributes(blockmodel, attributes=None, query=None)[source]

Read the attributes/variables from the BlockModel.

Parameters:
  • blockmodel (BlockModel) – The BlockModel to read from.

  • attributes (list[str]) – The attributes to include in the DataFrame.

  • query (str) – The query to filter the DataFrame.

Returns:

The DataFrame representing the attributes in the BlockModel.

Return type:

pd.DataFrame

Raises:

ValueError – If the attribute is not found in the BlockModel.