Release v0.12.0

Highlights

Compatibility with pyam v2.0

What's Changed

• Refactor MetaValidator tests to not use exclude indicator by @danielhuppmann in #272
• Extend the Countries docstring by @danielhuppmann in #273
• Check if path is contained in cwd by @phackstock in #276
• Update pyam-imports prior to pyam v2.0 by @danielhuppmann in #277
• Update supported python versions by @phackstock in #280
• Add RegionProcessor.revert() by @phackstock in #279
• Update RequiredDataValidator by @phackstock in #281
• Release candidate v0.12 by @danielhuppmann in #282

Full Changelog: v0.11.0...v0.12.0

Release v0.11.0

What's Changed

• Add a general-config feature to add all countries to RegionCodeList by @danielhuppmann in #262
• Import (region) definitions from other repository by @danielhuppmann in #264
• Add a module for translating between country names and alpha-2/3 codes by @danielhuppmann in #263
• Include definitions from GitHub repo by @phackstock in #265
• Improve the docs of the countries feature by @danielhuppmann in #266
• Rename US/British Virgin Islands in countries module by @danielhuppmann in #269
• Import mappings from external repo by @phackstock in #268
• Add config docs by @phackstock in #271

Full Changelog: v0.10.1...v0.11.0

Release v0.10.1

What's Changed

• Simplify docs folder structure, move to Black GitHub Actions by @danielhuppmann in #256
• Pin pydantic to < 2 by @phackstock in #260
• Add a model-registration xlsx template by @danielhuppmann in #257

Full Changelog: v0.10.0...v0.10.1

Release v0.10.0

What's Changed

• Remove jsonschema by @phackstock in #250
• Renamed 'countries' attribute to 'iso3_codes'in RegionCode class by @GretchenSchowalter in #252
• Allow ISO3 codes as string by @danielhuppmann in #253
• Meta validator by @GretchenSchowalter in #249
• Export aggregation difference to excel by @phackstock in #237
• Update the pyam-logo-path in the docs by @danielhuppmann in #254
• Add explanation on native-model-names by @danielhuppmann in #255

Full Changelog: v0.9.1...v0.10.0

Release v0.9.1

What's Changed

• Second PR to update the Nomenclature documentation by @GretchenSchowalter in #242
• MetaCode and MetaCodeList classes with allowed_values attribute by @GretchenSchowalter in #246
• Streamline code list filter by @phackstock in #245
• Update required data validator by @phackstock in #243
• Exclude defaults for yaml export by @phackstock in #247
• Added the countries attribute and check_iso3_codes() method to RegionCode object by @GretchenSchowalter in #240
• General cleanup by @phackstock in #244

Full Changelog: v0.9...v0.9.1

Release v0.9

Highlights

• RegionProcessor now requires a DataStructureDefinition as input
• Codelist instances now have a filter function which can be used to select Code objects based on attribute values

What's Changed

• Refactor RegionProcessor by @phackstock in #213
• Refactor RegionProcessor apply interface by @phackstock in #216
• Serialize and read complex attributes by @phackstock in #218
• Remove unnecessary test module by @phackstock in #229
• Hierarchy Filter (first pull request) by @GretchenSchowalter in #226
• Fix a bug where meta-indicators are dropped during region-processing by @danielhuppmann in #228
• Adding to hierarchy method in codelist.py by @GretchenSchowalter in #232
• Fix failing test after pandas 2.0 update by @phackstock in #235
• General Filter: Addresses the "Filter CodeLists by any attribute" issue #233 by @GretchenSchowalter in #236
• RegionCode class added with one hierarchy attribute by @GretchenSchowalter in #239
• Updated nomenclature documentation by removing the methods from being listed in the sidebar by @GretchenSchowalter in #238

New Contributors

• @GretchenSchowalter made their first contribution in #226

Full Changelog: v0.8...v0.9

Release v0.8

New features

Introduced the RequiredDataValidator class which is used for validating that a given pyam.IamDataFrame contains data specified by a given set of region, variable, unit, year.

What's Changed

• Correct test pypi installation test by @phackstock in #202
• Check against duplicate native region names (and rename-targets) by @danielhuppmann in #204
• Clean up imports by @phackstock in #206
• Improve readability of illegal unit error by @phackstock in #207
• Require data by @phackstock in #205
• Update pyam to >= 1.7.0 by @phackstock in #211
• Rename CodeList.invalid_items to CodeListvalidate_items by @phackstock in #212

Full Changelog: v0.7...v0.8

Release v0.7

New features

Improved tag replacement logic. Occurrences of {tag} inside a code object are now replaced with the tag name if the tag in question does not feature the attribute in question.

For further details please see https://nomenclature-iamc.readthedocs.io/en/stable/user_guide/codelist.html#the-tag-feature.

Breaking changes

The CodeList classes now contain dictionaries mapping the name of a code to a Code object. Previously instead of the Code object, a dictionary was used. Therefore attribute access has changed.

As an example, to access the file attribute of a code called "code1", previously we would have used codelist["code1"]["file"].
This will no longer work, instead codelist["code1"].file, has to be used.

In order to make this attribute access work, the allowed names of attributes have been restricted to valid, non-keyword, python identifiers. An attribute called "iso2" is allowed while an attribute called "while" or "2iso" is not. This restriction is enforced using a pydantic validator.

What's Changed

• Codelist/variable subclass by @luciecastella in #174
• Fix RegionAggregationMapping.common_region_names docstring by @phackstock in #178
• Quickfix to make yaml-check less stringent by @danielhuppmann in #179
• Add a to_csv() method by @danielhuppmann in #185
• Codelist/region subclass by @luciecastella in #177
• Cleanup RegionCodeList by @phackstock in #187
• Feature/code usage by @phackstock in #188
• Add multi unit support by @phackstock in #197
• Apply tag replacing to named attributes as well by @phackstock in #199
• Change attributes to extra_attributes by @phackstock in #200
• Simplify Code.attributes type hint by @phackstock in #195
• Check names of additional attribute keys by @phackstock in #196
• Improve tag replacement by @phackstock in #201

Full Changelog: v0.6...v0.7

Release v0.6

What's Changed

• Fix/small inconsistencies by @luciecastella in #167
• Fix a bug casting Norway-ISO2-code "NO" to bool False by @danielhuppmann in #171
• Fix/check hidden character by @luciecastella in #169
• Features/end whitespace by @luciecastella in #170
• Feature/no sub folder by @luciecastella in #168

Full Changelog: v0.5...v0.6

Release v0.5

What's Changed

• Check that weight variables exist by @phackstock in #133
• Restructure docs user-guide for toc-depth by @danielhuppmann in #140
• Docs/add howto by @phackstock in #144
• Fix 2 typos : model-mapping by @luciecastella in #149
• Change path representation to posix style by @phackstock in #150
• Add nightly run with multiple OS by @phackstock in #151
• Add CITATION.cff by @phackstock in #152
• Features/add cli folders by @luciecastella in #153
• Features/add cli option by @luciecastella in #147
• Check if user provided "mapping" attribute in assert_valid_structure by @phackstock in #156
• Docs/numpystyle use by @luciecastella in #159
• Add common vs native region explanation by @phackstock in #161
• Features/default command cli by @luciecastella in #160
• Docs/developing instructions by @luciecastella in #162
• Fix/stray tags by @luciecastella in #163

New Contributors

• @luciecastella made their first contribution in #149

Full Changelog: v0.4...v0.5