v0.5.0

Announcements

• The database is now portable and has explicit support for archival (see OpenSCMDB.to_gzipped_tar_archive) and unpacking (see OpenSCMDB.from_gzipped_tar_archive), however this also led to a number of breaking changes in the API, see below for details

Changelog

⚠️ Breaking Changes

• • Required db_dir to be passed when initialising [pandas_openscm.db.reader.OpenSCMDBReader][]. This is required to support portable databases
  • Renamed out_column_type to out_columns_type in [pandas_openscm.io.load_timeseries_csv][] for consistency with the rest of the API
  • Bumped the minimum supported version of filelock to 3.12.3, as only this version handles automatic creation of directories for the lock

  (#19)

🆕 Features

• • Made the database portable by only storing relative paths in the file map. This allows the database to be converted to an archive with [pandas_openscm.db.OpenSCMDB.to_gzipped_tar_archive][] and then unpacked elsewhere with [pandas_openscm.db.OpenSCMDB.from_gzipped_tar_archive][]
  • Added [pandas_openscm.db.path_handling][] to clarify how we handle paths internally to support portability
  • Added support for specifying the name of the output columns via [pandas_openscm.db.OpenSCMDB.load][], [pandas_openscm.db.reader.OpenSCMDBReader.load][] and [pandas_openscm.io.load_timeseries_csv][]

  (#19)

🎉 Improvements

• • Added the explicit [pandas_openscm.db.backends][] module to handle the backends we support more clearly
  • Added [pandas_openscm.db.backends.DataBackendOptions.guess_backend][] and [pandas_openscm.db.backends.IndexBackendOptions.guess_backend][] to allow for move convenient inference of the backend to use with different files

  (#19)

🔧 Trivial/Internal Changes

• #19

Changes

• 294df6d bump: version 0.4.3a1 -> 0.5.0
• 7bd7aaa Fix CHANGELOG cross-refs
• 759d814 CHANGELOG
• 52aeb7c Add explicit docs
• b650b13 Update minimum required version of filelock to handle directory creation
• 6998358 Add more tests
• 915c7a4 Add path handling test
• ee7da35 Add test of updated load_timeseries_csv
• 740069a Fix docs issue
• 305116e Add out columns name to other part of the API
• 0e5b545 Add control of column name in output
• d35afbd Expand tests
• 26b1203 Fix up tests
• 8c5d4e7 Propagate implications
• d1ceaf9 Pass unit test
• 95f53d1 WIP: Implement
• aea1e89 Add failing tests
• bf65fb5 bump(pre-release): version 0.4.2 > 0.4.3a1