Kinetics Toolkit 0.13 released

[felixchenier]

A new release on the road toward version 1.0. Remember that starting from 0.12, the API is mostly stable and we won't remove any feature or make any incompatible change before either 1.0 is released or before 2 years of deprecation warnings. It is safe to use Kinetics Toolkit in your work, we won't let you down!

In this release:

Improvements

• ktk.read_c3d() can now read the event contexts, not just the names, using the new include_event_context argument. If False, the events in the output TimeSeries are named after the events names in the C3D files, e.g.: "Start", "Heel Strike", "Toe Off". If True, the events in the output TimeSeries are named using this scheme "context:name", e.g.,: "General:Start", "Right:Heel strike", "Left:Toe Off". The default is False. Thanks @jorgomezga for suggesting and testing!
• TimeSeries' methods get_ts_between_indexes(), get_ts_between_times() and get_ts_between_events() now accept a new form for their argument inclusive. In addition to provide a simple boolean (False: strictly between, True: inclusive between), we can now provide a tuple/list of two booleans. For instance, [True, False] means "greater or equal to first index/time, and strictly less than second index/time".
• TimeSeries' methods get_ts_between_indexes(), get_ts_between_times() are now much faster on very long TimeSeries.
• Introducing progress bars for long operations, starting with ktk.cycles.detect_events(). If the optional package tqdm is installed, a progress bar is shown if the function takes lots of time. If it is not installed, the function works as usual, without a progress bar.

Bugfixes

• ktk.read_c3d() now works correctly with files with more than 255 markers or 255 analog signals, or with no labels. Kudos @jorgomezga for noticing and for proposing a fix!
• TimeSeries.get_ts_after_index and TimeSeries.get_ts_before_index now raises a TimeSeriesRangeError when index is invalid, instead of wrongly returning an empty TimeSeries.
• Function that expect integers as arguments do not complain anymore when they receive a numpy.int64 instead.
• Saving a Pandas DataFrame that contains different data types using ktk.save now loads back correctly.

As always, do not hesitate to ask for help on the discussion board. We are seeing more and more activity there and it is very motivating.