Skip to content

Clarify GPU contribution expectations and normalize Colab/tutorial repo references#27

Closed
Copilot wants to merge 5 commits into
masterfrom
copilot/enhance-gpu-process-module
Closed

Clarify GPU contribution expectations and normalize Colab/tutorial repo references#27
Copilot wants to merge 5 commits into
masterfrom
copilot/enhance-gpu-process-module

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 10, 2026

The issue asked how to contribute a combined set of gpu_process.pyx enhancements 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

    • Added a focused section in openpiv/docs/src/developers.rst describing how to submit related GPU enhancements in one PR.
    • Documented expected validation coverage for GPU work (CUDA/Colab execution and GPU test scope).
    • Added API compatibility guidance: avoid breaking public signatures; use compatibility wrappers/aliases when renames are necessary.
  • Repository/path consistency for Colab and tutorials

    • Updated README.md Colab links to use OpenPIV/openpiv-python-gpu.
    • Updated both GPU tutorial notebooks to replace fork-based install/data links with canonical OpenPIV repository references.
  • Developer onboarding correction

    • Updated developer clone instructions to point to the GPU repository used by this project.
# before (fork-specific)
pip install git+https://github.com/ericyang125/openpiv-python-gpu.git

# after (canonical)
pip install git+https://github.com/OpenPIV/openpiv-python-gpu.git

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
Copilot AI requested a review from alexlib May 10, 2026 17:08
@alexlib alexlib marked this pull request as ready for review May 10, 2026 17:52
Copilot AI review requested due to automatic review settings May 10, 2026 17:52
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-gpu repo.
  • Updated both GPU tutorial notebooks to replace fork-based install/data links with canonical OpenPIV references.
  • Updated developers.rst with 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": [
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Comment thread openpiv/tutorials/openpiv_python_gpu_tutorial_advanced.ipynb
@alexlib alexlib closed this May 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to contribute multiple changes to gpu_process.pyx module

3 participants