nextwheel 0.2.1a1__tar.gz

nextwheel-0.2.1a1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: nextwheel
+Version: 0.2.1a1
+Summary: Python module for NextWheel instrumented wheels
+Home-page: https://github.com/LabMOSA/NextWheel
+Author: NextWheel collaborators
+Author-email: chenier.felix@uqam.ca
+License: Apache
+Project-URL: Documentation, https://github.com/LabMOSA/NextWheel/tree/master/python
+Project-URL: Source, https://github.com/LabMOSA/NextWheel
+Project-URL: Tracker, https://github.com/LabMOSA/NextWheel/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# NextWheel Python module
+
+To install the Python module:
+
+```
+pip install git+https://github.com/felixchenier/NextWheel.git#subdirectory=software/python
+```
+
+To upgrade the Python module:
+
+```
+pip install --upgrade git+https://github.com/felixchenier/NextWheel.git#subdirectory=software/python
+```
+
+To use the module:
+
+```python
+>>> from nextwheel import NextWheel
+
+>>> nw = NextWheel("xx.xx.xx.xx")
+>>> nw.start_streaming()
+
+>>> print(nw.fetch())
+    
+>>> nw.stop_streaming()
+```
+
+Streamed data is sent by the wheel over UDP (by default, broadcast on port
+12345). Make sure your firewall accepts incoming UDP datagrams on this port.
+To change where the wheel sends its data (e.g., a different port for each
+wheel, or this computer's IP address instead of broadcast):
+
+```python
+>>> nw.start_streaming("255.255.255.255", 12346)
+```
+
+To see the list of recorded data files:
+
+```python
+>>> nw.file_list()
+```
+
+To download a file:
+
+```python
+>>> nw.file_download(filename)
+```
+
+To erase a file:
+
+```python
+>>> nw.file_delete(filename)
+```
+
+To read a file:
+
+```python
+>>> data = NextWheel.read_dat(filename)
+```

nextwheel-0.2.1a1/README.md

@@ -0,0 +1,59 @@
+# NextWheel Python module
+
+To install the Python module:
+
+```
+pip install git+https://github.com/felixchenier/NextWheel.git#subdirectory=software/python
+```
+
+To upgrade the Python module:
+
+```
+pip install --upgrade git+https://github.com/felixchenier/NextWheel.git#subdirectory=software/python
+```
+
+To use the module:
+
+```python
+>>> from nextwheel import NextWheel
+
+>>> nw = NextWheel("xx.xx.xx.xx")
+>>> nw.start_streaming()
+
+>>> print(nw.fetch())
+    
+>>> nw.stop_streaming()
+```
+
+Streamed data is sent by the wheel over UDP (by default, broadcast on port
+12345). Make sure your firewall accepts incoming UDP datagrams on this port.
+To change where the wheel sends its data (e.g., a different port for each
+wheel, or this computer's IP address instead of broadcast):
+
+```python
+>>> nw.start_streaming("255.255.255.255", 12346)
+```
+
+To see the list of recorded data files:
+
+```python
+>>> nw.file_list()
+```
+
+To download a file:
+
+```python
+>>> nw.file_download(filename)
+```
+
+To erase a file:
+
+```python
+>>> nw.file_delete(filename)
+```
+
+To read a file:
+
+```python
+>>> data = NextWheel.read_dat(filename)
+```