What’s New¶

v3.1.0 (2020-08-28)¶

All changes¶

ixmp v3.1.0 coincides with message_ix v3.1.0.

PR #345: Fix a bug in read_excel() when parameter data is spread across multiple sheets.
PR #363: Expand documentation and revise installation instructions.
PR #362: Raise Python exceptions from JDBCBackend.
PR #354: Add Scenario.items(), utils.diff(), and allow using filters in CLI command ixmp export.
PR #353: Add functionality for storing ‘meta’ (annotations of model names, scenario names, versions, and some combinations thereof).
- Add Backend.add_model_name(), add_scenario_name(), get_model_names(), get_scenario_names(), get_meta(), set_meta(), remove_meta().
- Allow these to be called from Platform instances.
- Remove Scenario.delete_meta().
PR #349: Avoid modifying indexers dictionary in AttrSeries.sel().
PR #343: Add region/unit parameters to Platform.export_timeseries_data().
PR #347: Preserve dtypes of index columns in data_for_quantity().
PR #339: ixmp show-versions includes the path to the default JVM used by JDBCBackend/JPype.
PR #317: Make reporting.Quantity classes interchangeable.
PR #330: Use GitHub Actions for continuous testing and integration.

v3.0.0 (2020-06-05)¶

ixmp v3.0.0 coincides with message_ix v3.0.0.

Migration notes¶

Excel input/output (I/O)

The file format used by Scenario.to_excel() and read_excel() is now fully specified; see File formats and input/output.

ixmp writes and reads items with more elements than the ~10⁶ row maximum of the Excel data format, by splitting these across multiple sheets.

The I/O code now explicitly checks for situations where the index sets and names for an item are ambiguous; see this example for how to initialize and read these items.

Updated dependencies

The minimum versions of the following dependencies are increased:

JPype1 0.7.5
pandas 1.0
dask 2.14 (for reporting)

Deprecations and deprecation policy

The following items, marked as deprecated in ixmp 2.0, are removed (PR #254):

$HOME/.local/ixmp/ as a configuration location. Configuration files are now placed in the standard $HOME/.local/share/ixmp/.
positional and dbtype= arguments to Platform/JDBCBackend.
first_model_year=, keep_sol=, and scen= arguments to clone(). Use shift_first_model_year, keep_solution, and scenario, respectively.
rixmp.legacy, an earlier version of the R interface that did not use reticulate.

Newly deprecated is:

cache keyword argument to Scenario. Caching is controlled at the Platform/Backend level, using the same keyword argument.

Starting with ixmp v3.0, arguments and other features marked as deprecated will follow a standard deprecation policy: they will be removed no sooner than the second major release following the release in which they are marked deprecated. For instance, a feature marked deprecated in ixmp version “10.5” would be retained in ixmp versions “11.x”, and removed only in version “12.0” or later.

All changes¶

PR #327: Bump JPype dependency to 0.7.5.
PR #298: Improve memory management in JDBCBackend.
PR #316: Raise user-friendly exceptions from Reporter.get() in Jupyter notebooks and other read–evaluate–print loops (REPLs).
PR #315: Ensure Model.initialize() is always called for new and cloned objects.
PR #320: Add CLI command ixmp show-versions to print ixmp and dependency versions for debugging.
PR #314: Bulk saving for metadata and exposing documentation API
PR #312: Add apply_units(), select() reporting calculations; expand Reporter.add().
PR #310: Reporter.add_product() accepts a Key with a tag; aggregate() preserves Quantity attributes.
PR #304: Add CLI command ixmp solve to run model solver.
PR #303: Add dims and units arguments to Reporter.add_file(); remove Reporter.read_config() (redundant with Reporter.configure()).
PR #295: Add option to include subannual column in dataframe returned by TimeSeries.timeseries().
PR #286, PR #297, PR #309: Add Scenario.to_excel() and read_excel(); this functionality is transferred to ixmp from message_ix and enhanced for dealing with maximum row limits in Excel.
PR #270: Include all tests in the ixmp package.
PR #212: Add Model.initialize() API to help populate new Scenarios according to a model scheme.
PR #267: Apply units to reported quantities.
PR #261: Increase minimum pandas version to 1.0; adjust for API changes and deprecations.
PR #243: Add export_timeseries_data() to write data for multiple scenarios to CSV.
PR #264: Implement methods to get and create new subannual timeslices.

v2.0.0 (2020-01-14)¶

ixmp v2.0.0 coincides with message_ix v2.0.0.

Migration notes¶

Support for Python 2.7 is dropped as it has reached end-of-life, meaning no further releases will be made even to fix bugs. See PEP-0373 and https://python3statement.org. ixmp users must upgrade to Python 3.

Configuration for ixmp and its storage backends has been streamlined. See the ref:Configuration section of the documentation for complete details on how to use ixmp platform add register local and remote databases. To migrate from pre-2.0 settings:

DB_CONFIG_PATH

…pointed to a directory containing database properties (.properties) files.

All Platform configuration is stored in one ixmp configuration file, config.json, and manipulated using the ixmp platform command and subcommands.
The Platform constructor accepts the name of a stored platform configuration.
Different storage backends may accept relative or absolute paths to backend-specific configuration files.

DEFAULT_DBPROPS_FILE

…gave a default backend via a file path.

On the command line, use ixmp platform add default NAME to set NAME as the default platform.
This platform is loaded when ixmp.Platform() is called without any arguments.

DEFAULT_LOCAL_DB_PATH

…pointed to a default local database.

ixmp.config always contains a platform named ‘local’ that is located below the configuration path, in the directory ‘localdb/default’.
To change the location for this platform, use e.g.: ixmp platform add local jdbc hsqldb PATH.

All changes¶

PR #240: Add ixmp list command-line tool.
PR #225: Ensure filters are always converted to string.
PR #189: Identify and load Scenarios using URLs.
PR #182, PR #200, PR #213, PR #217, PR #230, PR #245, PR #246: Add new Backend, Model APIs and CachingBackend, JDBCBackend, GAMSModel classes.
PR #188, PR #195: Enhance reporting.
PR #177: Add ability to pass gams_args through solve().
PR #175, PR #239: Drop support for Python 2.7.
PR #174: Set convertStrings=True for JPype >= 0.7; see the JPype changelog.
PR #173: Make AppVeyor CI more robust; support pandas 0.25.0.
PR #165: Add support for handling geodata.
PR #232: Fix exposing whole config file to log output.

v0.2.0 (2019-06-25)¶

ixmp 0.2.0 provides full support for clone() across platforms (database instances), e.g. from a remote database to a local HSQL database. IAMC-style timeseries data is better supported, and can be used to store processed results, together with model variables and equations.

Other improvements include a new, dedicated ixmp.testing module, and user-supplied callbacks in solve(). The retixmp package using reticulate to access the ixmp API is renamed to rixmp and now has its own unit tests (the former rixmp package can be accessed as rixmp.legacy).

Release 0.2.0 coincides with MESSAGEix release 1.2.0.

All changes¶

PR #135: Test rixmp (former retixmp) using the R testthat package.
PR #142: Cloning across platforms, better support of IAMC_style timeseries data, preparations for MESSAGEix release 1.2 in Java core.
PR #115: Support iterating with user-supplied callbacks.
PR #130: Recognize IXMP_DATA environment variable for configuration and local databases.
PR #129, PR #132: Fully implement clone() across platforms (databases).
PR #128, PR #137: New module ixmp.testing for reuse of testing utilities.
PR #125: Add functions to view and add regions for IAMC-style timeseries data.
PR #123: Return absolute path from find_dbprops().
PR #118: Switch to RTD Sphinx theme.
PR #116: Bugfix and extend functionality for working with IAMC-style timeseries data.
PR #111: Add functions to check if a Scenario has an item (set, par, var, equ).
PR #110: Generalize the internal functions to format index dimensions for mapping sets and parameters.
PR #108: Improve documentation.
PR #105: Replace deprecated pandas .ix indexer with .iloc.
PR #103: Specify dependencies in setup.py.

v0.1.3 (2018-11-21)¶

PR #88: Connecting to multiple databases, updating MESSAGE-scheme scenario specifications to version 1.1.
PR #80: Can now set logging level which is harmonized between Java and Python.
PR #79: Adding a deprecated-warning for ixmp.Scenario with scheme==’MESSAGE’.
PR #76: Changing the API from mp.Scenario(...) to ixmp.Scenario(mp, ...).
PR #73: Adding a function has_solution(), rename kwargs to …_solution.
PR #69: Bring retixmp available to other users.
PR #64: Support writing multiple sheets to Excel in utils.pd_write.
PR #61: Now able to connect to multiple databases (Platforms).
PR #58: Add MacOSX support in CI.
PR #52: Add ability to load all scenario data into memory for fast subsequent computation.