| Name | pivpy JSON |
| Version |
0.0.20
JSON |
| download |
| home_page | None |
| Summary | Python package for post-processing PIV results |
| upload_time | 2024-07-29 22:39:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright 2014- Turbulence Structure Laboratory, Tel Aviv University Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
example
documentation
tutorial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
scipy
xarray
netcdf4
matplotlib
pytest
typing-extensions
vortexfitting
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# <img src="pivpy_logo.png" alt="PIVPy" width="120" height="120"> PIVPy
Python based post-processing PIV data analysis
[](https://badge.fury.io/py/pivpy)
[](https://pivpy.readthedocs.io/en/latest/?badge=latest)
[](https://mybinder.org/v2/gh/alexlib/pivpy/master?filepath=examples%2Fnotebooks%2FGetting_Started.ipynb)
Merging the three packages:
1. https://github.com/tomerast/Vecpy
2. https://github.com/alexlib/pivpy/tree/xarray
3. https://github.com/ronshnapp/vecpy
### How do I get set up? ###
Use `pip`:
pip install pivpy
### What packages are required and which are optional
1. `lvreader` by Lavision if you use vc7 files
2. `netcdf4` if you want to store NetCDF4 files by xarray
3. `pyarrow` if you want to store parquet files
4. `vortexfitting` if you want to do vortex analysis ($\lambda_2$ and $Q$ criterions, vortex fitting)
5. `numpy`, `scipy`, `matplotlib`, `xarray` are must and installed with the `pivpy`
### How to get started?
Look into the [getting started Jupyter notebook](https://github.com/alexlib/pivpy/blob/master/examples/notebooks/Getting_Started.ipynb)
and additional notebooks:
[Notebooks](https://github.com/alexlib/pivpy/blob/master/examples/notebooks/)
### How to test? ###
From a command line just use:
pip install pytest
pytest
### Documentation on Github:
[PIVPy on ReadTheDocs](http://pivpy.readthedocs.io)
### 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 sphinx-build
sphinx-build -b html docs/source/ docs/build/html
generates ```docs/build/html``` directory with the documentation
Raw data
{
"_id": null,
"home_page": null,
"name": "pivpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "example documentation tutorial",
"author": null,
"author_email": "Alex Liberzon and Ron Shnapp <alex.liberzon@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/99/67/a470afa79b961e01354b1afd019b50b21a73875aa271b1dadeab7ddea426/pivpy-0.0.20.tar.gz",
"platform": null,
"description": "\n\n\n# <img src=\"pivpy_logo.png\" alt=\"PIVPy\" width=\"120\" height=\"120\"> PIVPy \n\nPython based post-processing PIV data analysis\n\n\n[](https://badge.fury.io/py/pivpy)\n[](https://pivpy.readthedocs.io/en/latest/?badge=latest)\n[](https://mybinder.org/v2/gh/alexlib/pivpy/master?filepath=examples%2Fnotebooks%2FGetting_Started.ipynb)\n\n\n\nMerging the three packages: \n1. https://github.com/tomerast/Vecpy\n2. https://github.com/alexlib/pivpy/tree/xarray\n3. https://github.com/ronshnapp/vecpy\n\n\n\n\n### How do I get set up? ###\n\nUse `pip`: \n\n pip install pivpy\n \n### What packages are required and which are optional\n\n1. `lvreader` by Lavision if you use vc7 files\n2. `netcdf4` if you want to store NetCDF4 files by xarray\n3. `pyarrow` if you want to store parquet files\n4. `vortexfitting` if you want to do vortex analysis ($\\lambda_2$ and $Q$ criterions, vortex fitting) \n5. `numpy`, `scipy`, `matplotlib`, `xarray` are must and installed with the `pivpy`\n \n### How to get started? \n\nLook into the [getting started Jupyter notebook](https://github.com/alexlib/pivpy/blob/master/examples/notebooks/Getting_Started.ipynb)\n\nand additional notebooks:\n[Notebooks](https://github.com/alexlib/pivpy/blob/master/examples/notebooks/)\n\n\n\n### How to test? ### \n\nFrom a command line just use:\n\n pip install pytest\n pytest\n \n### Documentation on Github:\n\n[PIVPy on ReadTheDocs](http://pivpy.readthedocs.io)\n\n### How to help? ###\n\nRead the ToDo file and pick one item to program. Use Fork-Develop-Pull Request model to \ncontribute\n\n### How to write tutorials and add those to the documentation ###\n\nUsing great tutorial http://sphinx-ipynb.readthedocs.org/en/latest/howto.html we now can \nprepare IPython notebooks (see in /docs/source) and convert those to .rst files, then \n\n python setup.py sphinx-build\n sphinx-build -b html docs/source/ docs/build/html\n \ngenerates ```docs/build/html``` directory with the documentation\n",
"bugtrack_url": null,
"license": "Copyright 2014- Turbulence Structure Laboratory, Tel Aviv University Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Python package for post-processing PIV results",
"version": "0.0.20",
"project_urls": {
"Bug Tracker": "https://github.com/alexlib/pivpy/issues",
"Homepage": "https://github.com/alexlib/pivpy"
},
"split_keywords": [
"example",
"documentation",
"tutorial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93d25c6dd9e651784b56e33f5f06c966948d4d5c11ff2eafbd8c545663f34fdb",
"md5": "9a29ad7e98275993da4246999651cf21",
"sha256": "b9c978840a2eaeabaa5536571180902a553b5d7918187fe59cd6011159012300"
},
"downloads": -1,
"filename": "pivpy-0.0.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a29ad7e98275993da4246999651cf21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5083713,
"upload_time": "2024-07-29T22:39:52",
"upload_time_iso_8601": "2024-07-29T22:39:52.732759Z",
"url": "https://files.pythonhosted.org/packages/93/d2/5c6dd9e651784b56e33f5f06c966948d4d5c11ff2eafbd8c545663f34fdb/pivpy-0.0.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9967a470afa79b961e01354b1afd019b50b21a73875aa271b1dadeab7ddea426",
"md5": "3030b8a1f52258f6d6d1a176427bf3c1",
"sha256": "481a8be24a02d21aa692dc0337ce70b63f7ac3a1e070a8c3750f4362e256b835"
},
"downloads": -1,
"filename": "pivpy-0.0.20.tar.gz",
"has_sig": false,
"md5_digest": "3030b8a1f52258f6d6d1a176427bf3c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5063087,
"upload_time": "2024-07-29T22:39:54",
"upload_time_iso_8601": "2024-07-29T22:39:54.695349Z",
"url": "https://files.pythonhosted.org/packages/99/67/a470afa79b961e01354b1afd019b50b21a73875aa271b1dadeab7ddea426/pivpy-0.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 22:39:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alexlib",
"github_project": "pivpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "xarray",
"specs": []
},
{
"name": "netcdf4",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "typing-extensions",
"specs": []
},
{
"name": "vortexfitting",
"specs": []
}
],
"lcname": "pivpy"
}
