https://github.com/ronshnapp/vecpy

Python based package for manipulation and presentation of PIV (particle image velocimetry) results.
https://github.com/ronshnapp/vecpy

Last synced: 15 days ago
JSON representation

Python based package for manipulation and presentation of PIV (particle image velocimetry) results.

• Host: GitHub
• URL: https://github.com/ronshnapp/vecpy
• Owner: ronshnapp
• License: bsd-3-clause
• Created: 2017-12-01T20:16:50.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-01T20:29:41.000Z (almost 7 years ago)
• Last Synced: 2024-02-17T13:33:15.920Z (9 months ago)
• Language: Jupyter Notebook
• Homepage:
• Size: 2.69 MB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• awesome_piv - ronshnapp / vecpy

README

        
### What is this repository for? ###

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.

### How do I get set up? ###

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.    

### How to test? ### 

From a command line just use:

    nosetests

    

### How to help? ###

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

contribute

### How to write tutorials and add those to the documentation ###

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