Release v2.2.2

Release v2.2.2

Patch release to correctly handle regexp-characters ([]{}?^) in filter() and better handling of the logging-configuration.

Release v2.2.1

Release v2.2.1

Patch release to explicitly include the requests dependency, which was dropped from ixmp4 with release 0.8.1.

Release v2.2.0

Release v2.2.0

Highlights

• Direct integration with ixmp4 platforms hosted by IIASA
• More flexible and intuitive signature for data validation and categorization
• Support for Python 3.12 and migrate to poetry & ruff

Dependency changes

• Replace pandas-datareader by wbdata to query World Bank data sources
• Bumped minimum version of pandas and numpy to fit ixmp4's requirements.

Individual updates

• #838 Support filters when reading from an ixmp4 platform
• #837 Support filters as direct keyword arguments for categorize() similar to validate() signature (see #804)
• #832 Improve the test-suite for the ixmp4 integration
• #827 Migrate to poetry for project management
• #830 Implement more consistent logging behavior with ixmp4
• #829 Add pyam.iiasa.platforms() for a list of available platforms
• #826 Add read_ixmp4() function and extend integration test
• #825 Add support for Python 3.12
• #824 Update ixmp4 requirement to >=0.7.1
• #821 Introduce ruff
• #818 Use context manager for reading Excel file
• #813 Fix a corner case in region-aggregation with missing data
• #797 Add to_ixmp4() method to write to an ixmp4 platform

Release v2.1.0

Release v2.1.0

Highlights

• More flexible and intuitive options for data validation
• Improved support for region-aggregation with inconsistent data/weight index
• Fix wrong color codes for AR6 Illustrative Pathways

Individual updates

• #804 Support filters as direct keyword arguments for validate() method
• #801 Support initializing with meta dataframe in long format
• #796 Raise explicit error message if no connection to IIASA manager service
• #794 Fix wrong color codes for AR6 Illustrative Pathways
• #792 Support region-aggregation with weights-index >> data-index

Release v2.0.0

Release v2.0.0

Highlights

• Use ixmp4 as dependency for better integration with the IIASA Scenario Explorer database infrastructure
• Refactor the "exclude"-column for validation as own attribute (instead of a column in meta)
• Implement a cleaner package structure and reduce exposure of internal methods/modules

Dependency changes

Support for Python 3.7-3.9 was removed due to an incompatible dependency.

PR #766 added the ixmp4 package for better integration with the IIASA scenario database infrastructure.

API changes

Credentials to access the IIASA scenario database infrastructure should now be managed using the ixmp4 package (see here).

The column exclude of the meta indicators was moved to a new attribute exclude. All validation methods are refactored such that the argument exclude_on_fail changes this new attribute (see PR #759).

The term "exclude" is now an illegal column for (timeseries) data and meta indicators. When importing an xlsx file created with pyam < 2.0, which has an "exclude" column in the "meta" sheet, the column is moved to the new exclude attribute with a log message.

PR #764 implemented a more restrictive approach to exposing pyam-internals at the package level, requiring a more explicit import of these methods. For example, use pyam.utils.to_list() instead of pyam.to_list().

PR #773 removed the map_regions() method. This feature is now implemented via the nomenclature.RegionProcessor class.

Individual updates

• #773 Remove map_regions() and default mappings csv
• #772 Show all missing rows for require_data()
• #771 Refactor to start a separate validation module
• #766 Use ixmp4 for credentials to access a Scenario Explorer database
• #764 Clean-up exposing internal methods and attributes
• #763 Implement a fix against carrying over unused levels when initializing from an indexed pandas object
• #759 Excise "exclude" column from meta and add a own attribute
• #747 Drop support for Python 3.7

Release v1.9.0

Release v1.9.0

Highlights

• Ensure compatibility with pandas v2.0
• Add Python 3.11 to supported versions
• Fix an issue when concatenating a list of pd.DataFrame objects

Individual updates

• #745 Add Python 3.11 to supported versions
• #742 Fix an issue when concatenating only pd.DataFrame objects
• #739 Ensure compatibility with pandas v2.0

Release v1.8.0

Release v1.8.0

Highlights

• Performance improvement at initialization and in internal operations
• Update the IIASA-Connection API in preparation of a new database backend
• Improve the tutorials

API changes

In anticipation of a change in the ixmp API, the argument default in the IIASA-Connection methods was renamed to default_only.

Individual updates

• #734 Validation for illegal column names in data
• #733 Change IIASA-Connection argument to default_only
• #732 Fix a few typos in tutorials
• #731 Add fast-path to initialization for sufficient multi-index
• #730 Refactor initialization code
• #729 Improve performance at initialization
• #723 Ensure correct order of time attribute

Release v1.7.0

Release v1.7.0

Highlights

• Add a feature to compute (weighted) quantiles for scenario data
• Implement a require_data() method for scenario validation
• Remove 'xls' as by-default-supported file format to harmonize behavior with pandas

API changes

The method compute_bias() was removed; please use compute.bias() instead.

Dependency changes

Remove xlrd as a dependency; please install it explicitly for reading .xls files.
Bump minimum version of pandas to v1.2.0 to support automatic engine selection.

Individual updates

• #715 Add a require_data() method
• #713 Informative error when using lists for filter by level, level now a forbidden column.
• #709 Hotfix ops to support fillna=0
• #708 Remove 'xls' as by-default-supported file format
• #686 Add support for (weighted) quantile timeseries as df.compute.quantiles() with a tutorial

Release v1.6.0

Release v1.6.0

Highlights

• Improved performance for writing data to xlsx
• Support for filtering by model-scenario pairs with an index argument
• Better integration with the IIASA Scenario Explorer database API

Dependency changes

PR #701 added xlsxwriter as a dependency for better performance.

Individual updates

• #702 Migrate compute_bias() to compute module
• #701 Add xlsxwriter as dependency to improve to_excel() performance
• #699 Add filter options to IIASA API index(), meta() and properties() methods
• #697 Add warning if IIASA API returns empty result
• #696 Added ability to load preferentially from a local cache
• #695 Remove unused meta levels during initialization
• #688 Remove ixmp as optional dependency
• #684 Use new IIASA-manager API with token refresh
• #679 set_meta() now supports pandas.DataFrame as an argument
• #674 Support filtering data by model-scenario pairs with the index argument to filter() and slice()

Release v1.5.0

Release v1.5.0

Highlights

This release introduces an IamSlice class that allows faster filtering and inspection of an IamDataFrame.

Individual updates

• #668 Allow renaming of empty IamDataFrame objects
• #665 Provide better support for IamDataFrame objects with non-standard index dimensions
• #659 Add an offset method
• #657 Add an IamSlice class