Clarify GPU contribution expectations and normalize Colab/tutorial repo references#27
Closed
Copilot wants to merge 5 commits into
Closed
Clarify GPU contribution expectations and normalize Colab/tutorial repo references#27Copilot wants to merge 5 commits into
Copilot wants to merge 5 commits into
Conversation
Agent-Logs-Url: https://github.com/OpenPIV/openpiv-python-gpu/sessions/85a079ee-bcfa-44d2-92f9-cafc65f2743f Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com>
Agent-Logs-Url: https://github.com/OpenPIV/openpiv-python-gpu/sessions/85a079ee-bcfa-44d2-92f9-cafc65f2743f Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com>
Agent-Logs-Url: https://github.com/OpenPIV/openpiv-python-gpu/sessions/85a079ee-bcfa-44d2-92f9-cafc65f2743f Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com>
Agent-Logs-Url: https://github.com/OpenPIV/openpiv-python-gpu/sessions/85a079ee-bcfa-44d2-92f9-cafc65f2743f Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add multiple enhancements to gpu_process.pyx module
Clarify GPU contribution expectations and normalize Colab/tutorial repo references
May 10, 2026
There was a problem hiding this comment.
Pull request overview
Updates contributor/developer documentation and tutorial/Colab references to consistently point to the canonical OpenPIV/openpiv-python-gpu repository, and adds guidance for bundling/validating larger GPU-related PRs.
Changes:
- Updated README Colab tutorial links to reference the
OpenPIV/openpiv-python-gpurepo. - Updated both GPU tutorial notebooks to replace fork-based install/data links with canonical
OpenPIVreferences. - Updated
developers.rstwith corrected clone instructions and added a “Submitting larger GPU changes” section describing expected validation and API-compat guidance.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Normalizes Colab tutorial links to the canonical OpenPIV/openpiv-python-gpu repository. |
| openpiv/tutorials/openpiv_python_gpu_tutorial_basic.ipynb | Updates Colab badge/install/data links from a fork to the canonical repo. |
| openpiv/tutorials/openpiv_python_gpu_tutorial_advanced.ipynb | Updates Colab badge/install references from a fork to the canonical repo. |
| openpiv/docs/src/developers.rst | Corrects clone instructions and documents expectations for larger GPU PR submission/validation and API compatibility. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
284
to
293
| "source": [ | ||
| "# check that GPU is connected and correct version of CUDA toolkit is installed. Should say CUDA Version 10.1\n", | ||
| "!nvidia-smi\n", | ||
| "!nvcc --version\n", | ||
| "\n", | ||
| "# Install from source.\n", | ||
| "!pip install git+https://github.com/ericyang125/openpiv-python-gpu.git\n" | ||
| "!pip install git+https://github.com/OpenPIV/openpiv-python-gpu.git\n" | ||
| ], | ||
| "execution_count": 1, | ||
| "outputs": [ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The issue asked how to contribute a combined set of
gpu_process.pyxenhancements safely, what validation should be expected, and whether public function names/arguments can change. This PR tightens contributor guidance around those points and fixes stale tutorial/docs references that were still pointing to a fork.Contributor guidance for multi-change GPU PRs
openpiv/docs/src/developers.rstdescribing how to submit related GPU enhancements in one PR.Repository/path consistency for Colab and tutorials
README.mdColab links to useOpenPIV/openpiv-python-gpu.OpenPIVrepository references.Developer onboarding correction