Release 3.0.2

Release 3.0.2 is a patch release.

• Fixed:
  • The string representation of empty headers used to wrongly print None, and will now correctly be an empty string.

Release 3.0.1

Release 3.0.1 is a patch release.

• Fixed:
  • Merging functionality from TfsDataFrame.append, TfsDataFrame.join, TfsDataFrame.merge and tfs.concat do not crash anymore when encountering a pandas.DataFrame (or more for tfs.concat) in their input. Signatures have been updated and tests were added for this behavior.

Release 3.0.0

Release 3.0.0: Breaking changes and long-term bug fix.

A long-standing issue where merging functionality used on TfsDataFrame (through .merge or pandas.concat for instance) would cause them to be cast back to pandas.DataFrame and lose their headers has been patched.

• Breaking changes:

  • The internal API has been reworked for clarity and consistency. Note that anyone previously using the high-level exports tfs.read, tfs.write and tfs.TfsDataFrame will not be affected.

• Added:

  • The TfsDataFrame class now has new .append, .join and .merge methods wrapping the inherited methods of the same name and fixing the aforementioned issue.
  • A tfs.frame.concat function, exported as tfs.concat, has been added to wrap pandas.concat and fix the aforementioned issue.
  • A tfs.frame.merge_headers function has been added.
  • Top level exports are now: tfs.TfsDataFrame, tfs.read, tfs.write and tfs.concat.

• Changes:

  • The tfs.frame.validate function is now a public-facing documented API and may be used stably.
  • The write_tfs function now appends an EOL (\n) at the end of the file when writing out for visual clarity and readability. This is a purely cosmetic and does not change functionality / compatibility of the files.
  • Documentation and README have been updated and cleared up.

Please do refer to the documentation for the use of the new merging functionality to be aware of caveats, especially when merging headers.

Release 2.1.0

Release 2.1.0 is a QoL change, bringing much faster loading of TFS files for users.

• Changes:
  • The parsing in read_tfs has been reworked to make use of pandas's C engine, resulting in drastic performance improvements when loading files. No functionality was lost or changed.

Release 2.0.3

• Fixed:

  • Took care of a numpy deprecation warning when using np.str, which should not appear anymore for users.

• Changes:

  • Prior to version 2.0.3, reading and writing would raise a TfsFormatError in case of non-unique indices or columns. From now on, this behavior is an option in read_tfs and write_tfscalled non_unique_behavior which by default is set to log a warning. If explicitely asked by the user, the failed check will raise a TfsFormatError.

Release 2.0.2

• Fixed:
  • Proper error on non-string columns
  • Writing numeric-only mixed type dataframes bug

Release 2.0.1

• Fixed:
  • No longer warns on MAD-X styled string column types (%[num]s).
  • Documentation is up-to-date, and plays nicely with Sphinx's parsing.

v2.0.0

Release 2.0.0: Breaking changes, fixes and more

Breaking changes:

• FixedColumn, FixedColumnCollection and FixedTfs have been removed from the package
• Objects are not converted to strings upon read anymore, and will raise an error
• Minimum pandas version is 1.0

Fixes:

• No longer writes an empty line to file in case of empty headers
• "Planed" dataframes capitalize plane key attributes to be consistent with other pylhc packages, however they can be accessed with and without capitalizing your query

Changes:

• Minimum required numpy version is now 1.19
• Full tests across supported Python versions and operating systems have been implemented
• Significant digits function can return the result as floats if ask to

Miscellaneous:

• Removed unused test dependencies
• Removed setup_requires as it is deprecated
• Reworked setup.py to be consistent with that of pylhc/omc3
• Improved testing and test coverage
• Improved logging
• Type hinting, docstrings and formatting

v1.0.5

Bump version: 1.0.4 → 1.0.5

v1.0.4

Updated CHANGELOG