Pysweepme: Difference between revisions
Franz Hempel (talk | contribs) (creation of pysweepme page) |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
pysweepme is a Python package | == Introduction to pysweepme == | ||
[https://github.com/SweepMe/pysweepme pysweepme] is a Python package crafted to seamlessly integrate SweepMe! instrument drivers into your Python projects. Its primary function is to load these drivers and establish interface ports, simplifying the incorporation of SweepMe! drivers into custom scripts. | |||
== Features == | |||
* '''Driver Integration''': Supports loading and utilization of SweepMe! instrument drivers. | |||
* '''Interface Port Creation''': Facilitates the creation of interface ports for communication. | |||
* '''Version Compatibility''': Correlates versioning with SweepMe! software, ensuring seamless integration and compatibility. | |||
* '''Open-Source''': Licensed under the MIT license, enabling modification and distribution under certain conditions. | |||
== Python environment == | |||
pysweepme comes with python package requirements that only cover those packages as needed by pysweepme. Several SweepMe! instrument drivers use further Python packages that are shipped with SweepMe!. For running SweepMe! instrument drivers with no import problems, we recommned to use Python packages requirements of SweepMe!. You can find the requirements.txt file of SweepMe! in the "libs" folder of your SweepMe! installation. This also includes pysweepme itself. Python packages used be SweepMe! drivers that are not part of the requirements.txt of SweepMe! are typically shipped with SweepMe! driver. | |||
== Python version == | |||
So far, pysweepme runs with Python 3.9, 3.10, or 3.11. We recommend to use Python 3.9 in accordance with the Python version used for SweepMe! 1.5.6. | |||
== GitHub Repository == | |||
For further details, instructions, and contributions, please visit the [https://github.com/SweepMe/pysweepme pysweepme GitHub page]. | |||
Latest revision as of 10:40, 15 January 2025
Introduction to pysweepme
pysweepme is a Python package crafted to seamlessly integrate SweepMe! instrument drivers into your Python projects. Its primary function is to load these drivers and establish interface ports, simplifying the incorporation of SweepMe! drivers into custom scripts.
Features
- Driver Integration: Supports loading and utilization of SweepMe! instrument drivers.
- Interface Port Creation: Facilitates the creation of interface ports for communication.
- Version Compatibility: Correlates versioning with SweepMe! software, ensuring seamless integration and compatibility.
- Open-Source: Licensed under the MIT license, enabling modification and distribution under certain conditions.
Python environment
pysweepme comes with python package requirements that only cover those packages as needed by pysweepme. Several SweepMe! instrument drivers use further Python packages that are shipped with SweepMe!. For running SweepMe! instrument drivers with no import problems, we recommned to use Python packages requirements of SweepMe!. You can find the requirements.txt file of SweepMe! in the "libs" folder of your SweepMe! installation. This also includes pysweepme itself. Python packages used be SweepMe! drivers that are not part of the requirements.txt of SweepMe! are typically shipped with SweepMe! driver.
Python version
So far, pysweepme runs with Python 3.9, 3.10, or 3.11. We recommend to use Python 3.9 in accordance with the Python version used for SweepMe! 1.5.6.
GitHub Repository
For further details, instructions, and contributions, please visit the pysweepme GitHub page.