Metadata-Version: 2.1
Name: ptvpy
Version: 0.6.1
Summary: A command line tool and library for particle tracking velocimetry.
Home-page: https://gitlab.com/tud-mst/ptvpy
Author: PtvPy developers
License: BSD 3-Clause License
Keywords: particle tracking velocimetry,PTV
Platform: UNKNOWN
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: cerberus
Requires-Dist: click
Requires-Dist: h5py
Requires-Dist: imageio
Requires-Dist: matplotlib
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: tifffile
Requires-Dist: toml
Requires-Dist: tqdm
Requires-Dist: trackpy

.. note::

   PtvPy is still in its early development and significant changes should be expected.
   Of course you are already welcome to try it out! Your feedback and suggestions will
   be of great value at this stage.

=====
PtvPy
=====
A command line tool and Python library for particle tracking velocimetry.
Its goal is to give domain experts an intuitive tool that provides reproducible
and reliable results without requiring programming skills. PtvPy heavily depends
on and extends functionality from the excellent library trackpy_. It furthermore
provides a periphery to visualize, analyze and export the data involved.

- Read the **documentation** at https://tud-mst.gitlab.io/ptvpy or
- get the **source code** at https://gitlab.com/tud-mst/ptvpy.

.. _trackpy: https://soft-matter.github.io/trackpy/


Contributing
============
Your own ideas, feedback and changes to PtvPy are always welcome! Feel free to
open a new issue_ to start a discussion or, if you want to contribute code yourself,
start with forking_ this repository and check out the
`contribution guide`_.

.. _issue: https://gitlab.com/tud-mst/ptvpy/issues/new?issue
.. _forking: https://gitlab.com/tud-mst/ptvpy/forks/new
.. _contribution guide: https://gitlab.com/tud-mst/ptvpy/blob/master/CONTRIBUTING.rst


History
=======
PtvPy was developed as an internal tool at the `Chair of Measurement & Sensor System
Technique`_ at the TU Dresden to facilitate data analysis. It was eventually published
in 2019 as open source software.

.. _Chair of Measurement & Sensor System Technique:
   https://tu-dresden.de/ing/elektrotechnik/iee/mst


License
=======
Licensed under the BSD 3-clause "New or revised" License. Parts of this software
are copyrighted or compatibly licensed by third parties as stated in the
`license file`_.

.. _license file: https://gitlab.com/tud-mst/ptvpy/blob/master/LICENSE.txt

Copyright (c) 2018-2019, PtvPy developers. All rights reserved.


