What’s New

Next release

All changes

v3.1.0 (2020-08-28)

All changes

ixmp v3.1.0 coincides with message_ix v3.1.0.

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

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

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.