What’s new

2022.11.7

Add the Zambia (ZMB) node code list (PR #83).
Add the utility same_time(), to copy the set time in paramenters (PR #83).
New Config and model.Config dataclasses for clearer description/handling of recognized settings stored on Context (PR #82). ConfigHelper for convenience/utility functionality in message_ix_models-based code.
New functions generate_product(), generate_set_elements(), get_region_codes() in model.structure (PR #82).
Revise and improve the Workflow API (PR #82).
Adjust for pandas 1.5.0 (PR #81).

Add nodes_ex_world() and use this in disutility.data_conversion() instead of expected a “World” node ID to be the first element in ScenarioInfo.N (PR #78).
Add example files and documentation for IIASA Scenario Explorer metadata (PR #78).
Expand ~ (i.e. $HOME) in the "message local data" configuration setting (PR #78).

Add get_advance_data(), and related tools for data from the ADVANCE project, including the node codelist for the data (PR #76).
Add unit annotations to Commodities (commodity.yaml) (PR #76).
New utility methods ScenarioInfo.io_units() to derive units for input and output parameters from units_for() commodity stocks and technology activities (PR #76).
Transfer add_tax_emission() from message_data, improve, and add tests (PR #76).
Unit annotations on commodity and technology codes are copied to child codes using process_units_anno() (PR #76).
make_matched_dfs() accepts pint.Quantity to set both magnitude and units in generated data (PR #76).
strip_par_data() also removes the set element for which data is being stripped (PR #76).
The common CLI options --verbose and --dry-run are stored on Context automatically (PR #76).
New utility method Context.set_scenario() (PR #76).
iam_units.registry is the default unit registry even when message_data is not installed (PR #76).
Expand broadcast() to allow DataFrame with multiple dimensions as input (PR #74).

Bump minimum required version of message_ix to v3.4.0 from v3.2.0 (PR #71).
Add a documentation page on Distributed computing (PR #59).
Add testing.not_ci() for marking tests not to be run on continuous integration services; improve session_context() (PR #62).
apply_spec() also adds elements of the “node” set using ixmp.Platform.add_region() (PR #62).
Add new logo the documentation (PR #68).
Add Workflow; see Multi-scenario workflows (workflow) (PR #60).

Change the node name in R12.yaml from R12_CPA to R12_RCPA (PR #49).
Register “message local data” ixmp configuration file setting and use to set the Context.local_path when provided. See (3) Other, system-specific (“local”) directories (PR #47)

New Spec class for easier handling of specifications of model (or model variant) structure (PR #39)
New utility function util.local_data_path() (PR #39).
repr() of Context no longer prints a (potentially very long) list of all keys and settings (PR #39).
as_codes() accepts a dict with Code values (PR #39).

Migrate utilities cached(), check_support(), convert_units(), maybe_query(), series_of_pint_quantity() (PR #27)
Add testing.NIE.
Add the --jvmargs option to pytest (see pytest_addoption()).
Remove Context.get_config_file(), get_path(), load_config(), and units(), all deprecated since 2021-02-28.

Add identify_nodes(), a function for identifying a Node code lists based on a Scenario (PR #24).
Add adapt_R11_R14(), a function for adapting data from the 11-region aggregation (R11) to the 14-region aggregation (R14) node lists (PR #24).
Add export_test_data() and mix-models export-test-data command (PR #16). See Prepare data for testing.
Allow use of pytest’s persistent cache across test sessions (PR #23). See Reproducibility.
Add the 12-region aggregation (R12) node code list (PR #14).

Add model.disutility, code for setting up structure and data for generalized consumer disutility (PR #13)

Migrate model.bare, model.build, model.cli, and associated documentation (PR #9)
Migrate utilities: ScenarioInfo, add_par_data(), eval_anno(), iter_parameters(), and strip_par_data().

Migrate util.click, util.logging; expand documentation (PR #8:).
Context.clone_to_dest() method replaces clone_to_dest() function.
Build PDF documentation on ReadTheDocs.
Allow CLI commands from both message_ix_models and message_data via mix-models.
Migrate mix-models techs CLI command.

Migrate Context class and testing module from message_data (PR #5:).
Add load_private_data(), package_data_path(), private_data_path().
Document: Data, metadata, and configuration and Command-line interface.
Update node codelists to ensure they contain both current and former ISO 3166 codes for countries that have changed status (PR #6:). For instance, ANT dissolved into BES, CUW, and SXM in 2010; all four are included in R11_LAM so this list can be used to handle data from either before or after 2010.

Initial release.