Metadata-Version: 2.1
Name: swft
Version: 0.3
Summary: Process swft files
Home-page: UNKNOWN
Author: Marc Endesfelder
Author-email: marc@endesfelder.de
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: pandas

Process _swft_ files generated by the _swift_ tracking software.

## Provided Functions
`load(path: str)`  
Load a _swft_ file specified by `path`.  
Returns a dictonary of type `{table_name: table}`. Each table is represented by a _pandas_ `DataFrame` with four additional attributes:

- `child: str`: Name of the child table (if any)
- `id_col: str`: Name of column in child table that contains the row ID of the parent
- `pos_col: str`: Name of column in child table that contains the position in parent (optional)
- `units: dict`: Dictionary of type `{column_name: unit}`. Does not have to contain an entry for every column.

`dump(dataset: dict, path: str)`  
Save `dataset`, a dictionary as specified above, to a file specified by `path`.


