Skip to content

Release 1.0.0

Choose a tag to compare

@JoschD JoschD released this 28 Oct 09:41
· 2 commits to master since this release
0fdbbd1

This is the first major release of turn_by_turn, marking the transition from a pre-1.0 version to a stable API.
This release includes introduces some small breaking changes to the API, mainly the removal of the date attribute from the TbtData dataclass, as it was not consistently populated across all datatypes and readers.
Instead a new attribute meta has been added
which is a dictionary to hold any additional metadata that might be relevant for a specific datatype or reader in the future,
or can be used to store user-defined metadata,
but the entries should not be relied upon to be present across all datatypes or readers.

Some common meta-entries are:

  • date: The date and time of the measurement, if available from the file.
  • file: The path to the file the data was loaded from.
  • source_datatype: The datatype the data was loaded from, e.g. lhc, sps, doros, etc.
  • comment: Any comment on the measurement.

Changed:

  • Removed the date attribute from the TbtData dataclass.
  • Reordered the parameters of the TbtData dataclass to have matrices, nturns first, as required attributes, then optinally bunch_ids, and meta.
  • Added a meta attribute to the TbtData dataclass to hold additional metadata as a dictionary.
  • Updated all readers to populate the meta attribute with relevant metadata where available.
  • Restructured the iota module. This should be mostly transparent to the user, unless they were using internal functions or classes from the iota module directly.

What's Changed

Full Changelog: 0.9.1...1.0.0