Revise README for NI Python Driver Examples - #23
Merged
Conversation
Updated the README to reflect the NI Python Driver Community Examples, including installation instructions and usage examples.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository README to describe the NI Python Driver Community Examples project, focusing on what examples exist and how to install prerequisites to run them.
Changes:
- Replaces the template README with project-specific description and driver/example list.
- Adds installation/prerequisites guidance and a short
pip installexample. - Adds system/python/hardware “Requirements” and a brief “Usage Examples” section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - NI driver Python packages (e.g., `nidcpower`, `nidmm`, `nifgen`, `nidigital`, `niscope`, `niswitch`) | ||
|
|
||
| ### Hardware Requirements | ||
| - Compatible National Instruments hardware (e.g., PXIe-4162, 4139 for DC Power Supply, NI-DAQmx compatible devices, etc.) |
Comment on lines
+25
to
+34
| -**Install Python Driver Packages** | ||
|
|
||
| Install the NI driver packages for the instruments you're using: | ||
| ```bash | ||
| # Example: Install nidcpower and nidmm drivers | ||
| pip install nidcpower | ||
| pip install nidmm | ||
| ``` | ||
|
|
||
| For a complete list of available NI Python drivers, visit [PyPI](https://pypi.org) and search for `ni` package names. |
Updated some additional details, after review.
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.
Updated the README to reflect the NI Python Driver Community Examples, including installation instructions and usage examples.