| Name | pydaq JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | None |
| Summary | Data Acquisition and Experimental Analysis with Python |
| upload_time | 2025-01-17 18:00:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | BSD 3-Clause License Copyright (c) 2023, Samir Angelo Milani Martins All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
python
data acquisition
arduino
nidaq
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="logo/pydaq-logo.png" alt= “PYDAQ” class=“center” width="50%" height="50%">
</p>
[](https://github.com/samirmartins/pydaq)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://pypi.org/project/pydaq/)
[](https://pypi.org/project/pydaq/)
[](https://github.com/samirmartins/pydaq/graphs/contributors)
[](https://pypi.org/project/pydaq/)
[](https://github.com/samirmartins/pydaq/issues)
[](https://github.com/samirmartins/pydaq/issues)
[](https://github.com/samirmartins/pydaq/network/members)
[](https://github.com/samirmartins/pydaq/stargazers)
# PYDAQ - Data Acquisition and Experimental Analysis with Python
## www.pydaq.org
----
Using Python for applications with experimental data (Arduino and NIDAQ boards)
----
This package was initially designed to use an experimental device for data
acquisition and signal generation when performing different experiments,
such as a step-response test. However, from version v0.0.5 onwards,
PYDAQ introduces different functionalities, including real-time system
identification using experimental data.
One can use PYDAQ using different boards [(check jupyter notebook examples folder)](examples),
through a Graphical User Interface or via command line.
It is noteworthy that this application makes data acquisition, system identification
and empirical experiments simpler, faster and easier. This is relevant
when the user needs empirical data to construct black box linear and
nonlinear models, commomly used in research projects in forecasting and
model-based control schemes.
The code provided here allows user to save acquired data in .dat files in
a path specified by the user (or at Desktop, if no path is provided), as well
as send a user-defined data, which can be any nonlinear input signal
[(you are strongly advised to check the docs)](https://pydaq.org)
In what follows you will find
- Installation and Requirements
- Quick view and Main features
- Using Graphical User Interface
- Screenshots
---
Installation and Requirements
---
The fastest way to install PYDAQ is using pip:
```console
pip install pydaq
```
PYDAQ requires:
- Driver of the board used (Arduino or National Instruments NIDAQ)
- nidaqmx (>=0.6.5) for data acquisition from National Instruments Boards
- matplotlib (>=3.5.3) as a visualization tool
- numpy (>=1.22.3) to process data
- PySide6 (>=6.7.1), PySide6_Addons, PySide6_Essentials and shiboken6 as a Graphical User Interface framework
- pyserial (>=3.5) to manage data to/from Arduino
- sysidentpy (==0.3.4) and bitarray (>=3.0.0) for model acquisition/signal generation
- packaging (>=24.1).
**NOTE 1:** In this version of pydaq (0.0.5), [(NI-DAQmx drivers)](https://www.ni.com/en/support/downloads/drivers/download.ni-daq-mx.html#494676) must be installed, even if
the user is only using Arduino Boards. This issue will be addressed in future versions, allowing
Arduino users to use PYDAQ without having to install NI-DAQmx drivers.
**NOTE 2:** PYDAQ is fully tested up to Python 3.10. It may run on versions above this, but without guarantees.
---
Quick view and Main features
---
| Feature | Description |
|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Send Data (Arduino/NIDAQ) | This feature allows the user to send data through any Arduino/NIDAQ board using a graphical user interface |
| Get Data (Arduino/NIDAQ) | Here the user is able to get data from a(n) Arduino/NIDAQ board (using any terminal configuration - Diff, RSE, NRSE - in NIDAQ case), sample time and other parameters. Acquired data can also be saved and plot for further applications |
| Step Response (Arduino/NIDAQ) | In this feature one can perform an automatic step response experiment using a(n) Arduino/NIDAQ board. Data genereted by the experiment can also be saved to be used in further applications, such as obtaining linear and nonlinear models from acquired data |
| Get Model (Arduino/NIDAQ) | The user can obtain mathematical models experimentally using Arduino/NIDAQ boards, with various customization options available. The input signal is a PRBS, which can be customized to meet specific needs, and both the input and output signals obtained can be saved for future applications. PYDAQ uses [SysIdentPy](www.sysidentpy.org) as a backend for obtaining the models. |
---
Using GUI (more details in [documentation](https://samirmartins.github.io/pydaq/) and [jupyter notebook examples](examples)):
---
All functionalities for all boards are incorporated in one single window.
### Launching the GUI:
```python
from pydaq.pydaq_global import PydaqGui
PydaqGui()
```
Further details can be found in [documentation](https://pydaq.org).
---
Screnshots (v0.0.5)
---
<p align="center">
<img src="docs//img/pydaq_long.gif" alt= “” class=“center” width="75%" height="75%">
</p>
---
Contributing
---
You are more than welcome to make your contribution and submit a pull request. To contribute, [read this guide](/CONTRIBUTING.md).
---
CITATION
---
[](https://doi.org/10.21105/joss.05662)
If you are using PYDAQ on your project, you can cite us as following:
- Martins, S. A. M. (2023). PYDAQ: Data Acquisition and Experimental Analysis with Python. Journal of Open Source Software, 8(92), 5662. https://doi.org/10.21105/joss.05662
```bibtex
@article{Martins_PYDAQ_Data_Acquisition_2023,
author = {Martins, Samir Angelo Milani},
doi = {10.21105/joss.05662},
journal = {Journal of Open Source Software},
month = dec,
number = {92},
pages = {5662},
title = {{PYDAQ: Data Acquisition and Experimental Analysis with Python}},
url = {https://joss.theoj.org/papers/10.21105/joss.05662},
volume = {8},
year = {2023}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pydaq",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Python, Data Acquisition, Arduino, NIDAQ",
"author": null,
"author_email": "Samir Angelo Milani Martins <milani.martins@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/68/d0/5ab7de9c5ff7b20be624951b7e0f28a660ab5b23b10e30fe9d7f10475e34/pydaq-0.0.5.tar.gz",
"platform": null,
"description": "<p align=\"center\">\r\n <img src=\"logo/pydaq-logo.png\" alt= \u201cPYDAQ\u201d class=\u201ccenter\u201d width=\"50%\" height=\"50%\">\r\n</p> \r\n\r\n[](https://github.com/samirmartins/pydaq)\r\n[](https://opensource.org/licenses/BSD-3-Clause)\r\n[](https://pypi.org/project/pydaq/)\r\n[](https://pypi.org/project/pydaq/)\r\n[](https://github.com/samirmartins/pydaq/graphs/contributors)\r\n[](https://pypi.org/project/pydaq/)\r\n[](https://github.com/samirmartins/pydaq/issues)\r\n[](https://github.com/samirmartins/pydaq/issues)\r\n[](https://github.com/samirmartins/pydaq/network/members)\r\n[](https://github.com/samirmartins/pydaq/stargazers)\r\n\r\n\r\n\r\n\r\n# PYDAQ - Data Acquisition and Experimental Analysis with Python\r\n\r\n## www.pydaq.org\r\n\r\n\r\n----\r\nUsing Python for applications with experimental data (Arduino and NIDAQ boards)\r\n----\r\n\r\nThis package was initially designed to use an experimental device for data \r\nacquisition and signal generation when performing different experiments, \r\nsuch as a step-response test. However, from version v0.0.5 onwards, \r\nPYDAQ introduces different functionalities, including real-time system \r\nidentification using experimental data.\r\n\r\nOne can use PYDAQ using different boards [(check jupyter notebook examples folder)](examples), \r\nthrough a Graphical User Interface or via command line. \r\n\r\nIt is noteworthy that this application makes data acquisition, system identification\r\nand empirical experiments simpler, faster and easier. This is relevant\r\nwhen the user needs empirical data to construct black box linear and\r\nnonlinear models, commomly used in research projects in forecasting and \r\nmodel-based control schemes.\r\n \r\nThe code provided here allows user to save acquired data in .dat files in \r\na path specified by the user (or at Desktop, if no path is provided), as well\r\nas send a user-defined data, which can be any nonlinear input signal \r\n[(you are strongly advised to check the docs)](https://pydaq.org)\r\n\r\nIn what follows you will find\r\n\r\n- Installation and Requirements\r\n- Quick view and Main features \r\n- Using Graphical User Interface\r\n- Screenshots\r\n\r\n\r\n\r\n---\r\nInstallation and Requirements\r\n---\r\n\r\nThe fastest way to install PYDAQ is using pip:\r\n\r\n```console\r\npip install pydaq\r\n```\r\n\r\nPYDAQ requires:\r\n\r\n- Driver of the board used (Arduino or National Instruments NIDAQ)\r\n- nidaqmx (>=0.6.5) for data acquisition from National Instruments Boards\r\n- matplotlib (>=3.5.3) as a visualization tool\r\n- numpy (>=1.22.3) to process data\r\n- PySide6 (>=6.7.1), PySide6_Addons, PySide6_Essentials and shiboken6 as a Graphical User Interface framework\r\n- pyserial (>=3.5) to manage data to/from Arduino\r\n- sysidentpy (==0.3.4) and bitarray (>=3.0.0) for model acquisition/signal generation\r\n- packaging (>=24.1).\r\n\r\n**NOTE 1:** In this version of pydaq (0.0.5), [(NI-DAQmx drivers)](https://www.ni.com/en/support/downloads/drivers/download.ni-daq-mx.html#494676) must be installed, even if \r\nthe user is only using Arduino Boards. This issue will be addressed in future versions, allowing\r\nArduino users to use PYDAQ without having to install NI-DAQmx drivers.\r\n\r\n**NOTE 2:** PYDAQ is fully tested up to Python 3.10. It may run on versions above this, but without guarantees. \r\n\r\n\r\n---\r\nQuick view and Main features\r\n---\r\n\r\n| Feature | Description |\r\n|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|\r\n| Send Data (Arduino/NIDAQ) | This feature allows the user to send data through any Arduino/NIDAQ board using a graphical user interface |\r\n| Get Data (Arduino/NIDAQ) | Here the user is able to get data from a(n) Arduino/NIDAQ board (using any terminal configuration - Diff, RSE, NRSE - in NIDAQ case), sample time and other parameters. Acquired data can also be saved and plot for further applications |\r\n| Step Response (Arduino/NIDAQ) | In this feature one can perform an automatic step response experiment using a(n) Arduino/NIDAQ board. Data genereted by the experiment can also be saved to be used in further applications, such as obtaining linear and nonlinear models from acquired data |\r\n| Get Model (Arduino/NIDAQ) | The user can obtain mathematical models experimentally using Arduino/NIDAQ boards, with various customization options available. The input signal is a PRBS, which can be customized to meet specific needs, and both the input and output signals obtained can be saved for future applications. PYDAQ uses [SysIdentPy](www.sysidentpy.org) as a backend for obtaining the models. |\r\n \r\n\r\n---\r\nUsing GUI (more details in [documentation](https://samirmartins.github.io/pydaq/) and [jupyter notebook examples](examples)):\r\n---\r\n\r\nAll functionalities for all boards are incorporated in one single window.\r\n\r\n### Launching the GUI:\r\n\r\n```python\r\nfrom pydaq.pydaq_global import PydaqGui\r\n\r\nPydaqGui()\r\n```\r\n\r\nFurther details can be found in [documentation](https://pydaq.org).\r\n\r\n---\r\nScrenshots (v0.0.5)\r\n---\r\n\r\n<p align=\"center\">\r\n <img src=\"docs//img/pydaq_long.gif\" alt= \u201c\u201d class=\u201ccenter\u201d width=\"75%\" height=\"75%\">\r\n</p>\r\n\r\n---\r\nContributing\r\n---\r\n\r\nYou are more than welcome to make your contribution and submit a pull request. To contribute, [read this guide](/CONTRIBUTING.md).\r\n\r\n\r\n---\r\nCITATION\r\n---\r\n[](https://doi.org/10.21105/joss.05662)\r\n\r\nIf you are using PYDAQ on your project, you can cite us as following: \r\n\r\n- Martins, S. A. M. (2023). PYDAQ: Data Acquisition and Experimental Analysis with Python. Journal of Open Source Software, 8(92), 5662. https://doi.org/10.21105/joss.05662\r\n\r\n```bibtex\r\n@article{Martins_PYDAQ_Data_Acquisition_2023,\r\n author = {Martins, Samir Angelo Milani},\r\n doi = {10.21105/joss.05662},\r\n journal = {Journal of Open Source Software},\r\n month = dec,\r\n number = {92},\r\n pages = {5662},\r\n title = {{PYDAQ: Data Acquisition and Experimental Analysis with Python}},\r\n url = {https://joss.theoj.org/papers/10.21105/joss.05662},\r\n volume = {8},\r\n year = {2023}\r\n}\r\n```\r\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, Samir Angelo Milani Martins All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Data Acquisition and Experimental Analysis with Python",
"version": "0.0.5",
"project_urls": {
"documentation": "https://pydaq.org/",
"homepage": "https://pydaq.org/",
"repository": "https://github.com/samirmartins/pydaq"
},
"split_keywords": [
"python",
" data acquisition",
" arduino",
" nidaq"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4594e53efd4031e525c9774df08c544c4344f2613c8b47e19ee7174f3a3064e9",
"md5": "ced5c58b02af480d840ab3e3de9fc3b9",
"sha256": "d688b282059a6e16530f514408c4d585b8f14141f28fe3d0c7c6afdb5708951d"
},
"downloads": -1,
"filename": "pydaq-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ced5c58b02af480d840ab3e3de9fc3b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 357194,
"upload_time": "2025-01-17T18:00:38",
"upload_time_iso_8601": "2025-01-17T18:00:38.875682Z",
"url": "https://files.pythonhosted.org/packages/45/94/e53efd4031e525c9774df08c544c4344f2613c8b47e19ee7174f3a3064e9/pydaq-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "68d05ab7de9c5ff7b20be624951b7e0f28a660ab5b23b10e30fe9d7f10475e34",
"md5": "847d686123873f6e90af3d9f121e277e",
"sha256": "ea244bf94f168ff3136d7c1b366e291f469af396118906e3fb9ad2ef95951c08"
},
"downloads": -1,
"filename": "pydaq-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "847d686123873f6e90af3d9f121e277e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 65701021,
"upload_time": "2025-01-17T18:00:49",
"upload_time_iso_8601": "2025-01-17T18:00:49.346442Z",
"url": "https://files.pythonhosted.org/packages/68/d0/5ab7de9c5ff7b20be624951b7e0f28a660ab5b23b10e30fe9d7f10475e34/pydaq-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-17 18:00:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "samirmartins",
"github_project": "pydaq",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pydaq"
}
