Public methods and standalone functions include their signatures and parameters. Filter the table by name or category, or open a category from the sidebar.

Calculation helpers include native SUT functions such as calc_u(), calc_s(), calc_U() and calc_S(), with equations, inputs and returned axes. See Calculations for the full formula overview.

Filter API entries

All 238Parsing 27Downloads 13Inspection 48Calculations 90Transformations 28Exports 5Templates 10Visualization 5Settings 12

238 entries

API	Category	Description
Database.parse_scenario	Parsing	Parse one compatible database and import it as a new scenario.
Database.parse_exiobase	Parsing	Parse one EXIOBASE payload and import it as a new scenario.
Database.parse_from_parquet	Parsing	Parse one parquet payload and import it as a new scenario.
load_test	Parsing	Load one of the packaged test databases.
parse_from_excel	Parsing	Parse a database from a single Excel workbook.
parse_from_txt	Parsing	Parse a database from a folder of text or CSV files.
parse_from_parquet	Parsing	Parse a database from a folder of parquet files.
parse_from_pymrio	Parsing	Convert a pymrio.IOSystem into a mario.Database.
parse_exiobase	Parsing	Dispatch to the appropriate EXIOBASE parser.
parse_bonsai	Parsing	Parse BONSAI Balanced HSUT or the native, already modelled b2 HIOT.
parse_figaro	Parsing	Parse FIGARO tables from the Eurostat API.
parse_gloria	Parsing	Parse a locally downloaded GLORIA release.
parse_gtap	Parsing	Parse a locally downloaded GTAP bundle.
parse_wiod	Parsing	Parse one WIOD 2016 multiregional Excel workbook from the official release.
parse_oecd	Parsing	Parse OECD ICIO, OECD national IOT, or OECD SUT datasets.
parse_eora	Parsing	Parse EORA data into a Database instance.
parse_emerging	Parsing	Parse one EMERGING MATLAB bundle from the supported Zenodo releases.
parse_ceads	Parsing	Parse one local CEADS China provincial MRIO workbook.
parse_cepalstat	Parsing	Parse selected local CEPALSTAT COU/MIP bundles.
parse_bea	Parsing	Parse one local BEA Supply-Use release bundle.
parse_adb	Parsing	Parse one locally downloaded ADB MRIO or SRIO Excel workbook.
parse_useeio	Parsing	Parse one local USEEIO workbook export.
parse_statcan	Parsing	Parse Statistics Canada supply-use or symmetric I-O tables via WDS.
parse_istat	Parsing	Parse official ISTAT input-output workbooks from local files or a downloaded release.
parse_eurostat	Parsing	Parse Eurostat national tables directly from the official SDMX API.
parse_exiobase_3	Parsing	Parse a monetary EXIOBASE IOT folder into a Database instance.
parse_exiobase_sut	Parsing	Parse the monetary EXIOBASE SUT into a Database instance.
download_eurostat	Downloads	Download one Eurostat SDMX slice to local CSV files.
download_statcan	Downloads	Download one StatCan full-table CSV to a local file.
download_statcan_openio_canada	Downloads	Download the OpenIO-Canada emission-factor workbook for 2022 only.
download_istat_io	Downloads	Download one official ISTAT input-output release zip from the public release page.
download_wiod2016	Downloads	Download one WIOD 2016 multiregional workbook from the official release links.
download_wiod2016_iot_pyp	Downloads	Download the WIOD 2016 MRIO IOT workbook in previous-year prices.
download_wiod2016_national_iot	Downloads	Download the WIOD 2016 national IOT workbook bundle.
download_wiod2016_national_sut	Downloads	Download the WIOD 2016 national SUT workbook bundle.
download_wiod2016_socioeconomic_accounts	Downloads	Download the WIOD 2016 socio-economic accounts workbook.
download_emerging	Downloads	Download the EMERGING Zenodo bundle supported by MARIO.
download_hybrid_exiobase	Downloads	Download the EXIOBASE hybrid v3.3.18 files needed by MARIO.
download_exiobase3	Downloads	Download a selected monetary EXIOBASE 3 release from Zenodo.
download_exiobase_monetary	Downloads	Alias for :func:`download_exiobase3`.
Database.query	Inspection	Return matrices from one or more scenarios with a compact shape.
Database.get_data	Inspection	Return matrices, units and indexes in a structured payload.
CoreModel.get_block	Inspection	Return the stored block object for a scenario without conversion.
CoreModel.get_block_as_pandas	Inspection	Return one block converted to a pandas object.
CoreModel.get_block_as_table	Inspection	Return one block in the requested tabular backend.
CoreModel.get_block_as_matrix	Inspection	Return one block in a numeric matrix backend.
CoreModel.set_block	Inspection	Store one block in the selected scenario.
CoreModel.has_block	Inspection	Backward-compatible alias for :meth:`has_matrix`.
CoreModel.has_matrix	Inspection	Return whether one matrix is materialized for a scenario.
CoreModel.list_matrices	Inspection	List all matrices currently materialized for one scenario.
CoreModel.matrices	Inspection	Scenario mappings with canonical keys and current-alias lookup.
CoreModel.available_matrices	Inspection	Return all matrix names available on the current instance.
CoreModel.available_blocks	Inspection	Backward-compatible alias for :meth:`available_matrices`.
Database.DataFrame	Inspection	Return a single dataframe view of one scenario.
CoreModel.get_block_spec	Inspection	Return the semantic block specification for a block name.
CoreModel.register_block_spec	Inspection	Register a semantic block specification on the current database.
CoreModel.list_custom_block_specs	Inspection	List custom block specifications registered on the instance.
CoreModel.register_operator	Inspection	Register a custom compute operator on the current database.
CoreModel.list_custom_operators	Inspection	List custom compute operators registered on the instance.
CoreModel.get_index	Inspection	Return one index level or the full index mapping for the database.
CoreModel.get_concordances	Inspection	Return classification codes for this database's native items.
CoreModel.available_concordances	Inspection	Available target classification editions, grouped by native set.
CoreModel.get_aggregation	Inspection	Build a proposed aggregation from this database's concordances.
CoreModel.available_aggregations	Inspection	Classification editions and hierarchy levels usable by get_aggregation.
CoreModel.database_profile	Inspection	Database-specific GHG, compute and concordance metadata.
get_database_profile	Inspection	Inspect registered database metadata without parsing or calculating data.
CoreModel.search	Inspection	Search index values matching a pattern within one set or across all sets.
CoreModel.sets	Inspection	Return the named index levels exposed by the current table type.
CoreModel.units	Inspection	Return database units with alias-aware access on set labels.
CoreModel.table_type	Inspection	Return the database table type.
CoreModel.tech_assumption	Inspection	Return the structural technology assumption stored on the database.
CoreModel.scenarios	Inspection	Return the list of available scenario names.
CoreModel.baseline_scenario_name	Inspection	Return the public name exposed for the internal baseline scenario.
CoreModel.directory	Inspection	Return the default output directory used by the database.
CoreModel.meta_history	Inspection	Print the full metadata history.
CoreModel.save_meta	Inspection	Persist metadata history to disk.
CoreModel.add_note	Inspection	Append one or more user notes to the metadata history.
Database.clusters	Inspection	Return the currently stored user-defined shock clusters.
Database.default_clusters	Inspection	Return the automatically generated default shock clusters.
Database.available_clusters	Inspection	Return the effective clusters available to shock helpers.
Database.copy	Inspection	Return a deep copy of the database object.
Database.backup	Inspection	Store a deep-copy backup of matrices, indexes and units.
CoreModel.GDP	Inspection	Return GDP totals or sector-level GDP for a scenario.
CoreModel.is_balanced	Inspection	Check whether a scenario is balanced under a chosen criterion.
CoreModel.is_hybrid	Inspection	Return whether the database mixes multiple measurement units.
CoreModel.is_multi_region	Inspection	Return whether the database contains more than one region.
CoreModel.is_chenerymoses	Inspection	Test whether a multi-regional SUT follows the Chenery-Moses format.
CoreModel.is_isard	Inspection	Test whether a multi-regional SUT follows the Isard format.
CoreModel.calc_all	Calculations	Compute and materialize one or more matrices for a scenario.
CoreModel.resolve	Calculations	Resolve and materialize one matrix through the compute resolver.
CoreModel.resolve_many	Calculations	Resolve and materialize several matrices through the compute resolver.
CoreModel.explain	Calculations	Explain how MARIO would resolve one matrix.
Database.calc_linkages	Calculations	Calculate backward and forward linkages for one scenario.
Database.calc_ghg	Calculations	Aggregate satellite GHG accounts into a new label row.
Database.calc_trades	Calculations	Calculate region-by-region trade matrices for one item.
Database.calc_trades_content	Calculations	Calculate region-by-region embodied trade content for one indicator.
Database.calc_trades_content_breakdown	Calculations	Deprecated wrapper for contributor-level trade content outputs.
Database.calc_spa	Calculations	Run a first structural path analysis on one IOT scenario.
Database.calc_embodied_imports	Calculations	Calculate embodied imports by destination Region for one indicator.
Database.calc_embodied_exports	Calculations	Calculate embodied exports by origin Region for one indicator.
Database.calc_embodied_net_imports	Calculations	Calculate embodied net imports as imports minus exports.
Database.calc_trades_concentration	Calculations	Calculate contributor-region concentration of embodied trade content.
Database.calc_trades_exposure	Calculations	Calculate embodied trade-content exposure to one or more contributor Regions.
calc_u	Calculations	Calculate the SUT use coefficients matrix u.
calc_U	Calculations	Calculate the SUT use flows matrix U.
calc_s	Calculations	Calculate the SUT supply coefficients matrix s under IT or PT.
calc_S	Calculations	Calculate the SUT supply flows matrix S under IT or PT.
calc_c	Calculations	Calculate the SUT product-mix matrix c for product-based technology.
calc_Xa	Calculations	Calculate SUT activity production Xa from supply flows and final demand.
calc_Xc	Calculations	Calculate SUT commodity production Xc from use flows and final demand.
calc_wcc	Calculations	Calculate the SUT commodity-to-commodity Leontief block wcc.
calc_wca	Calculations	Calculate the SUT commodity-to-activity Leontief block wca.
calc_wac	Calculations	Calculate the SUT activity-to-commodity Leontief block wac.
calc_waa	Calculations	Calculate the SUT activity-to-activity Leontief block waa.
calc_bu	Calculations	Calculate the SUT use direct-output coefficients bu.
calc_bs	Calculations	Calculate the SUT supply direct-output coefficients bs.
calc_gcc	Calculations	Calculate the SUT Ghosh block gcc.
calc_gca	Calculations	Calculate the SUT Ghosh block gca.
calc_gac	Calculations	Calculate the SUT Ghosh block gac.
calc_gaa	Calculations	Calculate the SUT Ghosh block gaa.
calc_pa	Calculations	Calculate the SUT activity price index pa.
calc_pc	Calculations	Calculate the SUT commodity price index pc.
calc_X	Calculations	Calculate the X total production vector from Z and Y.
calc_z	Calculations	Calculate the z intersectoral transaction coefficients matrix.
calc_Z	Calculations	Calculate the Z intersectoral transaction flows matrix.
calc_w	Calculations	Calculate the w Leontief inverse matrix.
calc_X_from_z	Calculations	Calculate the X total production vector directly from z and Y.
calc_X_from_w	Calculations	Calculate the X total production vector from w and Y.
calc_v	Calculations	Calculate the v value added coefficients matrix.
calc_V	Calculations	Calculate the V value added transaction flows matrix.
calc_e	Calculations	Calculate the e environmental transaction coefficients matrix.
calc_E	Calculations	Calculate the E environmental transaction flows matrix.
calc_m	Calculations	Calculate the m total (direct+indirect) value added coefficients matrix.
calc_m_from_z	Calculations	Calculate the m total (direct+indirect) value added coefficients matrix.
calc_M	Calculations	Calculate the M total (direct+indirect) value added transaction matrix.
calc_f	Calculations	Calculate the f total (direct+indirect) environmental transaction coefficients matrix.
calc_f_from_z	Calculations	Calculate the f total (direct+indirect) environmental transaction coefficients matrix.
calc_F	Calculations	Calculate the F total (direct+indirect) environmental transaction flows matrix.
calc_p	Calculations	Calculate the p price index vector from v and w.
calc_p_from_z	Calculations	Calculate the p price index vector directly from v and z.
calc_b	Calculations	Calculate the b intersectoral transaction direct-output coefficients matrix.
calc_g	Calculations	Calculate the g Ghosh coefficients matrix.
calc_y	Calculations	Normalize the Y final demand matrix by its grand total.
calc_f_dis	Calculations	Calculate a diagonalized representation of f.
calc_Va	Calculations	Calculate the Va activity-side value added flows matrix.
calc_Vc	Calculations	Calculate the Vc commodity-side value added flows matrix.
calc_va	Calculations	Calculate the va activity-side value added coefficients matrix.
calc_vc	Calculations	Calculate the vc commodity-side value added coefficients matrix.
calc_Ea	Calculations	Calculate the Ea activity-side environmental flows matrix.
calc_Ec	Calculations	Calculate the Ec commodity-side environmental flows matrix.
calc_ea	Calculations	Calculate the ea activity-side environmental coefficients matrix.
calc_ec	Calculations	Calculate the ec commodity-side environmental coefficients matrix.
calc_ma	Calculations	Calculate the ma activity-side total value added coefficients matrix.
calc_mc	Calculations	Calculate the mc commodity-side total value added coefficients matrix.
calc_Ma	Calculations	Calculate the Ma activity-side total value added flows matrix.
calc_Mc	Calculations	Calculate the Mc commodity-side total value added flows matrix.
calc_fa	Calculations	Calculate the fa activity-side total environmental coefficients matrix.
calc_fc	Calculations	Calculate the fc commodity-side total environmental coefficients matrix.
calc_Fa	Calculations	Calculate the Fa activity-side total environmental flows matrix.
calc_Fc	Calculations	Calculate the Fc commodity-side total environmental flows matrix.
CoreModel.f_ex	Calculations	Return exploded environmental multiplier contributions for IOT.
CoreModel.f_ex_all	Calculations	Exploded satellite footprints (IOT, all accounts, baseline).
CoreModel.fa_ex	Calculations	Return activity-side exploded environmental multipliers for SUT.
CoreModel.fa_ex_all	Calculations	Activity-side exploded satellite footprints (SUT, all accounts, baseline).
CoreModel.fc_ex	Calculations	Return commodity-side exploded environmental multipliers for SUT.
CoreModel.fc_ex_all	Calculations	Commodity-side exploded satellite footprints (SUT, all accounts, baseline).
CoreModel.m_ex	Calculations	Return exploded value-added multipliers for IOT: diag(v) @ w.
CoreModel.m_ex_all	Calculations	Exploded value-added multipliers (IOT, all factors, baseline).
CoreModel.ma_ex	Calculations	Return activity-side exploded value-added multipliers for SUT.
CoreModel.ma_ex_all	Calculations	Activity-side exploded value-added multipliers (SUT, all factors, baseline).
CoreModel.mc_ex	Calculations	Return commodity-side exploded value-added multipliers for SUT.
CoreModel.mc_ex_all	Calculations	Commodity-side exploded value-added multipliers (SUT, all factors, baseline).
CoreModel.p_ex	Calculations	Return exploded price-index contributions for IOT.
CoreModel.p_ex_all	Calculations	Exploded price-index contributions (IOT, baseline).
CoreModel.pa_ex	Calculations	Return activity-side exploded price-index contributions for SUT.
CoreModel.pa_ex_all	Calculations	Activity-side exploded price-index contributions (SUT, baseline).
CoreModel.pc_ex	Calculations	Return commodity-side exploded price-index contributions for SUT.
CoreModel.pc_ex_all	Calculations	Commodity-side exploded price-index contributions (SUT, baseline).
Database.aggregate	Transformations	Aggregate one or more classification levels in the database.
Database.add_extensions	Transformations	Add new extensions to value added or satellite accounts.
Database.keep_extensions	Transformations	Keep only the selected satellite accounts in every scenario.
Database.add_sectors	Transformations	Apply the add-sectors workbook to the selected scenario.
Database.ras	Transformations	Balance the Z block of one IOT scenario with the RAS method.
Database.to_iot	Transformations	Transform a SUT database into an IOT database.
Database.to_region_subset	Transformations	Keep one explicit region subset and externalize the remaining regions.
Database.to_single_region	Transformations	Extract one region from a multi-regional database.
Database.to_chenery_moses	Transformations	Transform an Isard SUT into a Chenery-Moses SUT.
Database.pool_trade	Transformations	Pool the trade of selected commodities behind one pass-through layer.
Database.change_assumption	Transformations	Change the structural SUT technology assumption.
Database.update_supply_mix	Transformations	Update one regional supply mix in the selected scenario.
Database.update_trade_mix	Transformations	Update the regional sourcing mix of one traded item per destination market.
Database.get_mix	Transformations	Return one region-by-sector production mix from X.
Database.update_supply_mix_iot	Transformations	IOT-only alias for :meth:`update_supply_mix`, kept for backward compatibility.
Database.update_mix_iot	Transformations	Backward-compatible alias for :meth:`update_supply_mix_iot`.
Database.clone_scenario	Transformations	Clone an existing scenario into a new scenario name.
Database.rename_scenario	Transformations	Rename one existing scenario.
Database.rename_baseline_scenario	Transformations	Change the public name exposed for the baseline scenario.
Database.update_scenarios	Transformations	Replace selected stored matrices in an existing scenario.
Database.shock_calc	Transformations	Apply shocks to coefficients or demand and store the result as a scenario.
Database.reset_to_flows	Transformations	Reset a scenario so only flow-side matrices remain materialized.
Database.reset_to_coefficients	Transformations	Reset a scenario so only coefficient-side matrices remain materialized.
Database.set_clusters	Transformations	Persist reusable shock clusters on the database.
Database.add_cluster	Transformations	Add or replace one stored shock cluster.
Database.clear_clusters	Transformations	Remove all stored shock clusters from the database.
Database.replace_units_name	Transformations	Rename unit labels inside one unit table without touching matrix data.
Database.build_new_instance	Transformations	Build a new database whose baseline is the selected scenario.
Database.export	Exports	Export selected matrices as flat, matrix-specific files.
Database.to_excel	Exports	Export one scenario to the historical MARIO Excel format.
Database.to_txt	Exports	Export one scenario as multiple text or CSV files.
Database.to_parquet	Exports	Export one scenario as parquet files.
Database.to_pymrio	Exports	Export an IOT database as a pymrio.IOSystem.
write_template_definition	Templates	Write the workbook used to define sets and units before data entry.
write_parse_template	Templates	Write one MARIO-ready Excel template from user-defined sets and units.
Database.get_aggregation_excel	Templates	Write an aggregation template workbook for the selected levels.
Database.get_extensions_excel	Templates	Write an Excel template for adding extensions to E or V.
Database.get_add_sectors_excel	Templates	Write the add-sectors workbook template.
Database.get_shock_excel	Templates	Write an Excel template for defining shocks.
Database.read_aggregated_index	Templates	Load aggregation mappings without applying them yet.
Database.read_add_sectors_excel	Templates	Read add-sectors workbook inputs and attach their metadata to the database.
Database.get_inventory_sheets	Templates	Create inventory-sheet templates referenced by an add-sectors workbook.
Database.read_inventory_sheets	Templates	Read and group inventory sheets from an add-sectors workbook.
Database.plot	Visualization	Build one interactive plot from a matrix or a prepared dataframe.
Database.plot_matrix	Visualization	Deprecated wrapper around :meth:`plot` for matrix bar plots.
Database.plot_gdp	Visualization	Deprecated wrapper for sectoral GDP treemap and sunburst plots.
Database.plot_linkages	Visualization	Deprecated wrapper for plotting linkage indicators.
Database.plot_bubble	Visualization	Deprecated wrapper for a GDP or extension bubble chart.
download_settings	Settings	Return a copy of the current session settings, optionally exporting YAML.
get_settings_path	Settings	Return the user configuration file path without creating or loading it.
upload_settings	Settings	Replace settings for this Python process without modifying the package.
reset_settings	Settings	Restore built-in defaults, leaving stored matrices intact.
set_compute_method	Settings	Set the default runtime method used for demand-driven IOT/SUT calculations.
set_linear_solver	Settings	Set the default backend used by solve-based demand-driven formulas.
set_linear_strategy	Settings	Set how MARIO should solve sparse linear systems under compute_method='solve'.
set_singular_policy	Settings	Choose how solve-based calculations handle singular production systems.
PartialResultWarning	Settings	Some coefficients cannot be certified because the system is singular.
set_log_verbosity	Settings	Configure MARIO logging verbosity and warning capture.
set_palette	Settings	Set the default discrete palette used by MARIO plots.
slicer	Settings	Helps to slice the matrices