pivtools 0.1.2__tar.gz

pivtools-0.1.2/MANIFEST.in

@@ -0,0 +1,27 @@
+include README.md
+include LICENSE
+include requirements.txt
+include config.yaml
+
+# Include C library source files
+recursive-include pivtools_cli/lib *.c *.h
+
+# Include GUI static files and templates
+recursive-include pivtools_gui/static *
+recursive-include pivtools_gui/templates *
+
+# Exclude unnecessary files
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.dll
+global-exclude *.dylib
+
+# Exclude test and development files
+prune tests
+prune manual_tools
+prune logs
+prune env
+prune .git
+prune .github

pivtools-0.1.2/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: pivtools
+Version: 0.1.2
+Summary: PIVTOOLs - Particle Image Velocimetry Tools with CLI and GUI
+Author-email: Your Name <your.email@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/MTT69/python-PIVTOOLs
+Project-URL: Repository, https://github.com/MTT69/python-PIVTOOLs
+Project-URL: Issues, https://github.com/MTT69/python-PIVTOOLs/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Framework :: Flask
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: dask[distributed]==2025.7.0
+Requires-Dist: loguru==0.7.3
+Requires-Dist: numpy==2.2.6
+Requires-Dist: opencv-python==4.12.0.88
+Requires-Dist: pandas==2.3.1
+Requires-Dist: pillow==11.3.0
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: scipy==1.16.1
+Requires-Dist: tifffile==2025.6.11
+Requires-Dist: tqdm==4.67.1
+Requires-Dist: numba==0.61.2
+Requires-Dist: psutil==6.1.1
+Requires-Dist: pytest==8.4.2
+Requires-Dist: rawpy==0.25.1
+Requires-Dist: scikit-image==0.25.2
+Requires-Dist: lvpyio==1.3.1; sys_platform != "darwin"
+Requires-Dist: bottleneck==1.6.0
+Requires-Dist: scikit-learn==1.7.2
+Requires-Dist: threadpoolctl==3.6.0
+Requires-Dist: Flask==3.1.1
+Requires-Dist: flask-cors==6.0.1
+Requires-Dist: matplotlib==3.10.5
+
+# PIVTOOLs
+
+Particle Image Velocimetry Tools - A comprehensive toolkit for PIV analysis with both command-line and GUI interfaces.
+
+## Installation
+
+Install PIVTOOLs with a single command:
+
+```bash
+pip install pivtools
+```
+
+This installs the complete toolkit including:
+- **Core utilities** for image handling and vector processing
+- **Command-line interface** (`pivtools-cli`) for automated workflows
+- **Web-based GUI** (`pivtools-gui`) for interactive analysis
+
+The package includes pre-compiled C extensions for optimal performance on Windows, macOS, and Linux.
+
+## Quick Start
+
+### Initialize a new PIVTOOLs workspace
+
+```bash
+pivtools-cli init
+```
+
+This creates a default `config.yaml` file in your current directory that you can edit to configure your PIV analysis.
+
+### Run PIV analysis (command-line)
+
+```bash
+pivtools-cli run
+```
+
+This runs the PIV analysis using the `config.yaml` in your current directory.
+
+### Launch the GUI
+
+```bash
+pivtools-gui
+```
+
+This starts the web-based GUI at http://localhost:5000 where you can interactively configure and run PIV analysis.
+
+## Configuration
+
+Edit the `config.yaml` file to configure:
+
+- Input/output paths
+- Image formats and processing parameters
+- PIV algorithm settings
+- Filtering and post-processing options
+- Calibration parameters
+
+See the example `config.yaml` for all available options.
+
+## Requirements
+
+- Python 3.8+
+- FFTW library (automatically handled during installation)
+- Camera calibration images (for accurate scaling)
+
+## Development
+
+For development installation with local C compilation:
+
+```bash
+# Install FFTW first (platform-specific)
+# Windows: vcpkg install fftw3[threads]:x64-windows-static
+# macOS: brew install fftw gcc
+# Linux: apt-get install libfftw3-dev
+
+# Set environment variables
+export FFTW_INC_PATH=/path/to/fftw/include
+export FFTW_LIB_PATH=/path/to/fftw/lib
+
+# Install in development mode
+pip install -e .
+```
+
+## License
+
+MIT License
+
+Particle Image Velocimetry Tools - A comprehensive toolkit for PIV analysis with both command-line and GUI interfaces.
+
+## Installation
+
+Install PIVTOOLs from PyPI:
+
+```bash
+pip install PIVTOOLs
+```
+
+This will install the package with pre-compiled C extensions for your platform.
+
+## Quick Start
+
+### Initialize a new PIV workspace
+
+```bash
+pivtools-cli init
+```
+
+This creates a `config.yaml` file in your current directory with default settings.
+
+### Run PIV analysis (command line)
+
+```bash
+pivtools-cli run
+```
+
+### Launch the GUI
+
+```bash
+pivtools-gui
+```
+
+Then open http://localhost:5000 in your browser.
+
+## Configuration
+
+Edit the `config.yaml` file to configure:
+
+- Input/output paths
+- Image formats and processing parameters
+- PIV algorithm settings
+- Filtering and post-processing options
+
+## Requirements
+
+- Python 3.8+
+- FFTW library (automatically handled during installation)
+- See `requirements.txt` for full dependencies
+
+## Development
+
+For development installation:
+
+```bash
+git clone https://github.com/MTT69/python-PIVTOOLs.git
+cd python-PIVTOOLs
+pip install -e .
+```
+
+## Building from Source
+
+If building from source, ensure FFTW is installed:
+
+### Linux (Ubuntu/Debian)
+```bash
+sudo apt-get install libfftw3-dev
+```
+
+### macOS
+```bash
+brew install fftw
+```
+
+### Windows
+Install FFTW via vcpkg:
+```bash
+vcpkg install fftw3[threads]:x64-windows-static
+```
+
+Set environment variables:
+```bash
+set FFTW_INC_PATH=C:\path\to\fftw\include
+set FFTW_LIB_PATH=C:\path\to\fftw\lib
+```
+
+## License
+
+MIT License
+
+## Contributing
+
+Contributions welcome! Please see the GitHub repository for issues and pull requests.

pivtools-0.1.2/README.md

@@ -0,0 +1,179 @@
+# PIVTOOLs
+
+Particle Image Velocimetry Tools - A comprehensive toolkit for PIV analysis with both command-line and GUI interfaces.
+
+## Installation
+
+Install PIVTOOLs with a single command:
+
+```bash
+pip install pivtools
+```
+
+This installs the complete toolkit including:
+- **Core utilities** for image handling and vector processing
+- **Command-line interface** (`pivtools-cli`) for automated workflows
+- **Web-based GUI** (`pivtools-gui`) for interactive analysis
+
+The package includes pre-compiled C extensions for optimal performance on Windows, macOS, and Linux.
+
+## Quick Start
+
+### Initialize a new PIVTOOLs workspace
+
+```bash
+pivtools-cli init
+```
+
+This creates a default `config.yaml` file in your current directory that you can edit to configure your PIV analysis.
+
+### Run PIV analysis (command-line)
+
+```bash
+pivtools-cli run
+```
+
+This runs the PIV analysis using the `config.yaml` in your current directory.
+
+### Launch the GUI
+
+```bash
+pivtools-gui
+```
+
+This starts the web-based GUI at http://localhost:5000 where you can interactively configure and run PIV analysis.
+
+## Configuration
+
+Edit the `config.yaml` file to configure:
+
+- Input/output paths
+- Image formats and processing parameters
+- PIV algorithm settings
+- Filtering and post-processing options
+- Calibration parameters
+
+See the example `config.yaml` for all available options.
+
+## Requirements
+
+- Python 3.8+
+- FFTW library (automatically handled during installation)
+- Camera calibration images (for accurate scaling)
+
+## Development
+
+For development installation with local C compilation:
+
+```bash
+# Install FFTW first (platform-specific)
+# Windows: vcpkg install fftw3[threads]:x64-windows-static
+# macOS: brew install fftw gcc
+# Linux: apt-get install libfftw3-dev
+
+# Set environment variables
+export FFTW_INC_PATH=/path/to/fftw/include
+export FFTW_LIB_PATH=/path/to/fftw/lib
+
+# Install in development mode
+pip install -e .
+```
+
+## License
+
+MIT License
+
+Particle Image Velocimetry Tools - A comprehensive toolkit for PIV analysis with both command-line and GUI interfaces.
+
+## Installation
+
+Install PIVTOOLs from PyPI:
+
+```bash
+pip install PIVTOOLs
+```
+
+This will install the package with pre-compiled C extensions for your platform.
+
+## Quick Start
+
+### Initialize a new PIV workspace
+
+```bash
+pivtools-cli init
+```
+
+This creates a `config.yaml` file in your current directory with default settings.
+
+### Run PIV analysis (command line)
+
+```bash
+pivtools-cli run
+```
+
+### Launch the GUI
+
+```bash
+pivtools-gui
+```
+
+Then open http://localhost:5000 in your browser.
+
+## Configuration
+
+Edit the `config.yaml` file to configure:
+
+- Input/output paths
+- Image formats and processing parameters
+- PIV algorithm settings
+- Filtering and post-processing options
+
+## Requirements
+
+- Python 3.8+
+- FFTW library (automatically handled during installation)
+- See `requirements.txt` for full dependencies
+
+## Development
+
+For development installation:
+
+```bash
+git clone https://github.com/MTT69/python-PIVTOOLs.git
+cd python-PIVTOOLs
+pip install -e .
+```
+
+## Building from Source
+
+If building from source, ensure FFTW is installed:
+
+### Linux (Ubuntu/Debian)
+```bash
+sudo apt-get install libfftw3-dev
+```
+
+### macOS
+```bash
+brew install fftw
+```
+
+### Windows
+Install FFTW via vcpkg:
+```bash
+vcpkg install fftw3[threads]:x64-windows-static
+```
+
+Set environment variables:
+```bash
+set FFTW_INC_PATH=C:\path\to\fftw\include
+set FFTW_LIB_PATH=C:\path\to\fftw\lib
+```
+
+## License
+
+MIT License
+
+## Contributing
+
+Contributions welcome! Please see the GitHub repository for issues and pull requests.

pivtools-0.1.2/config.yaml

@@ -0,0 +1,135 @@
+paths:
+  base_paths:
+  - C:\Users\mtt1e23\Downloads\calibrated_piv_morgan
+  source_paths:
+  - D:\DAVIS_BFS\gF_Ramp_experiment\BFS_1500_1
+  camera_numbers:
+  - 1
+  - 2
+  camera_count: 2
+images:
+  num_images: 10
+  image_format:
+  - B%05d.im7
+  vector_format:
+  - '%05d.mat'
+  time_resolved: false
+  dtype: float32
+batches:
+  size: 25
+logging:
+  file: pypiv.log
+  level: INFO
+  console: true
+processing:
+  instantaneous: true
+  ensemble: false
+  stereo: false
+  backend: cpu
+  debug: false
+  auto_compute_params: false
+  omp_threads: 4
+  dask_workers_per_node: 5
+  dask_threads_per_worker: 1
+  dask_memory_limit: 12GB
+outlier_detection:
+  enabled: true
+  methods:
+  - threshold: 0.25
+    type: peak_mag
+  - epsilon: 0.2
+    threshold: 2
+    type: median_2d
+infilling:
+  mid_pass:
+    method: biharmonic
+    parameters:
+      ksize: 3
+  final_pass:
+    enabled: true
+    method: biharmonic
+    parameters:
+      ksize: 3
+plots:
+  save_extension: .png
+  save_pickle: true
+  fontsize: 14
+  title_fontsize: 16
+videos:
+- endpoint: ''
+  type: instantaneous
+  use_merged: false
+  variable: ux
+  video_length: 100
+- endpoint: ''
+  type: gamma1
+  use_merged: false
+  variable: gamma1
+  video_length: 100
+statistics_extraction: null
+instantaneous_piv:
+  window_size:
+  - - 128
+    - 128
+  - - 64
+    - 64
+  - - 32
+    - 32
+  overlap:
+  - 50
+  - 50
+  - 50
+  runs:
+  - 3
+  time_resolved: false
+  window_type: gaussian
+  num_peaks: 1
+  peak_finder: gauss3
+  secondary_peak: false
+calibration_format:
+  image_format: calib%05d.tif
+calibration:
+  active: pinhole
+  scale_factor:
+    dt: 0.56
+    px_per_mm: 3.41
+    source_path_idx: 0
+  pinhole:
+    source_path_idx: 0
+    camera: 1
+    image_index: 0
+    file_pattern: calib%05d.tif
+    pattern_cols: 10
+    pattern_rows: 10
+    dot_spacing_mm: 28.89
+    enhance_dots: true
+    asymmetric: false
+    dot_distance_mm: 28.9
+    grid_tolerance: 0.5
+    ransac_threshold: 3
+    dt: 0.0275
+  stereo:
+    source_path_idx: 0
+    camera_pair:
+    - 1
+    - 2
+    file_pattern: planar_calibration_plate_*.tif
+    pattern_cols: 10
+    pattern_rows: 10
+    dot_spacing_mm: 28.89
+    enhance_dots: true
+    asymmetric: false
+    dt: 2
+  image_format: calib%05d.tiff
+filters:
+- type: pod
+masking:
+  enabled: true
+  mask_file_pattern: mask_Cam%d.mat
+  mask_threshold: 0.01
+  mode: file
+  rectangular:
+    top: 64
+    bottom: 64
+    left: 0
+    right: 0