mario.parse_useeio#

mario.parse_useeio(path: str, *, format: str = 'auto', table: str = 'SUT', model_alias: str | None = None, release_year: int | None = None, model: str = 'Database', name: str | None = None, calc_all: bool = False, **kwargs) → object#

Parse one local USEEIO workbook export.

Parameters:

  • path (str) – path to one local USEEIO*.xlsx workbook or to a directory containing a single workbook.

  • format (str, optional) – workbook layout selector. This is a parser-side file-format selector, not a USEEIO model alias. auto is the default and currently resolves to v2.5_workbook when the workbook matches the known USEEIO v2.5 export structure.

  • model_alias (str, optional) – USEEIO model alias used to select one workbook when path points to a directory containing multiple exports, for example "yellowthroat" or "waxwing".

  • release_year (int, optional) – USEEIO workbook release year used with model_alias to select a specific directory workbook. Both 22 and 2022 are accepted.

  • table (str, optional) – currently only SUT is supported.

  • model (str, optional) – public MARIO model class to instantiate. Database is the default and the only supported value.

  • name (str, optional) – optional dataset name stored in metadata.

  • calc_all (bool, optional) – whether to materialize derived blocks immediately after parsing.

Notes

In USEEIO naming, aliases such as yellowthroat, kingbird, oriole, or waxwing identify different model families and contents. MARIO’s format= argument instead identifies the workbook structure that the parser knows how to read. Different aliases can therefore share the same parser format.

The currently relevant published national v2.5 aliases include:

  • yellowthroat and waxwing: GLORIA-backed models, respectively at BEA Summary and BEA Detail level, with GHG and material-footprint extensions;

  • kingbird and kinglet: EXIOBASE-backed models, respectively at BEA Summary and BEA Detail level, with GHG extensions;

  • oriole and catbird: CEDA-backed models, respectively at BEA Summary and BEA Detail level, with GHG extensions.

The supported v2.5 workbook layout is parsed as a split-native SUT:

  • S from workbook V;

  • U, Yc and Va from the extended workbook U block;

  • Ec from B * q because the verified v2.5 workbook stores the direct environmental coefficient matrix on the commodity axis.

No automatic download is implemented yet. Callers should point the parser to one local workbook.

On this page