mario.parse_ceads#

mario.parse_ceads(path: str, *, format: str = 'auto', table: str = 'IOT', year: int | None = None, model: str = 'Database', name: str | None = None, calc_all: bool = False, **kwargs) → object#

Parse one local CEADS China provincial MRIO workbook.

Parameters:

  • path (str) – local workbook path or one directory containing one or more supported CEADS workbooks.

  • format (str, optional) – workbook layout selector. auto is the default and currently resolves to ceads_provincial_workbook for the verified 2018/2020 CEADS workbook family.

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

  • year (int, optional) – workbook year used to disambiguate one directory containing more than one supported workbook.

  • 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

Verified local format:

  • CEADS provincial MRIO workbooks for 2018 and 2020, distributed as Excel files through figshare and the CEADS data portal.

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

On this page