Metadata-Version: 2.1
Name: ptvpy
Version: 0.7.0
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
Project-URL: Documentation, https://tud-mst.gitlab.io/ptvpy
Project-URL: Issue tracker, https://gitlab.com/tud-mst/ptvpy/issues
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: trackpy
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: sphinx (==1.8.5) ; extra == 'dev'
Requires-Dist: numpydoc ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'

=====
PtvPy
=====

`Source code <https://gitlab.com/tud-mst/ptvpy>`_ |
`Documentation <https://tud-mst.gitlab.io/ptvpy>`_ |
`Issue tracker <https://gitlab.com/tud-mst/ptvpy/issues>`_

A free and open-source command line tool and Python library for
`particle tracking velocimetry`_ enabling a flexible workflow with reproducible
and reliable results.
PtvPy depends on and extends functionality from the excellent library trackpy_ and
provides a periphery to visualize, analyze and export the data involved.

It is developed at the `Chair of Measurement & Sensor System Technique`_ at the TU
Dresden to facilitate data analysis.
It was eventually published in 2019 as free and open-source software.

.. _particle tracking velocimetry:
   https://en.wikipedia.org/wiki/Particle_tracking_velocimetry
.. _trackpy: https://soft-matter.github.io/trackpy/
.. _Chair of Measurement & Sensor System Technique:
   https://tu-dresden.de/ing/elektrotechnik/iee/mst


Installation
============

PtvPy is available for Python 3.6 and higher and can be installed from PyPI with::

    pip install ptvpy


Contributing
============
Your own ideas, feedback and changes to PtvPy are always welcome!
Feel free open a new issue_ to get in touch and check out the `contribution guide`_.

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


License
=======
PtvPy is licensed under the BSD 3-clause "New or revised" License.
Parts of this project may be 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.


