This repository contains the code of a Python based module that is made for the sake of working with .vec file. these are PIV result files that are generated by the insight program.

to start working just download the code and run the init.py script file. this script imports all the other code needed for running the program properly. also, given a proper path destination and a file name of an example .vec file, this script will generate example plots.

From a command line just use:

nosetests

Read the ToDo file and pick one item to program. Use Fork-Develop-Pull Request model to contribute

Using great tutorial http://sphinx-ipynb.readthedocs.org/en/latest/howto.html we now can prepare IPython notebooks (see in /docs/source) and convert those to .rst files, then

python setup.py build_sphinx

generates html directory with the documentation ready