| Name | zahner-potentiostat JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | Library to control Zahner Potentiostats. |
| upload_time | 2024-05-24 05:49:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Zahner-Elektrik Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
potentiostat
electrochemistry
chemistry
eis
cyclic voltammetry
fuel-cell
battery
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# zahner_potentiostat
zahner_potentiostat is a library to control external [Zahner Potentiostats](https://zahner.de/products#external-potentiostats) like **PP212, PP222, PP242, XPOT2 or EL1002**.
It was developed to **easily integrate** external Zahner Potentiostats into Python scripts for more **complex measurement** tasks and for **automation purposes**.
The control concept is that there are different primitives which can be combined for different electrochemical measurement methods.
These primitives can all be configured differently to match the application. In the documentation in the respective function all possible configuration setter methods are listed. The complete documentation of the functions can be found on the [API documentation website](https://doc.zahner.de/zahner_potentiostat/).
> [!NOTE]
> **Only with this library and a PP212, PP222, PP242, EL1002 or XPOT2 device you can not use AC methods. For AC methods like EIS a [Zennium](https://zahner.de/products#potentiostats) with [EPC](https://zahner.de/products-details/addon-cards/epc42) and the [thales_remote](https://github.com/Zahner-elektrik/Thales-Remote-Python) library is necessary.**
**The following [primitives](https://en.wikipedia.org/wiki/Language_primitive) are available to compose methods with:**
* Potentiostatic or galvanostatic polarization
* [measurePolarization()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measurePolarization)
* Open circuit voltage/potential scan
* [measureOCV()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureOCV)
* [measureOCVScan()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureOCVScan)
* Ramps potentiostatic or galvanostatic
* [measureRampValueInTime()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureRampValueInTime)
* [measureRampValueInScanRate()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureRampValueInScanRate)
* [measureRampScanRateForTime()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureRampScanRateForTime)
* Staircase potentiostatic or galvanostatic
* [measureIEStairs()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureIEStairs)
**And as an example, the following methods were developed from the primitives:**
* Charge or discharge something
* [measureCharge()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureCharge)
* [measureDischarge()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureDischarge)
* Output potentiostatic or galvanostatic profile as potentiostatic or galvanostatic polarizations or ramps
* [measureProfile()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureProfile)
* PITT Potentiostatic Intermittent Titration Technique
* [measurePITT()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measurePITT)
* GITT Galvanostatic Intermittent Titration Technique
* [measureGITT()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureGITT)
Further measurements like EIS and CV can be done in connection with a Zennium with the package [thales_remote](https://github.com/Zahner-elektrik/Thales-Remote-Python).
# 🔧 Installation
The package can be installed via pip.
```
pip install zahner_potentiostat
```
# 🔨 Basic Usage
```python
'''
Search the Zahner Potentiostat
'''
deviceSearcher = SCPIDeviceSearcher()
deviceSearcher.searchZahnerDevices()
commandSerial, dataSerial = deviceSearcher.selectDevice("35000")
'''
Connect to the Potentiostat
'''
ZahnerPP2x2 = SCPIDevice(SerialCommandInterface(commandSerial), SerialDataInterface(dataSerial))
'''
Setup measurement
'''
ZahnerPP2x2.setSamplingFrequency(25)
ZahnerPP2x2.setCoupling(COUPLING.POTENTIOSTATIC)
ZahnerPP2x2.setMaximumTimeParameter(15)
'''
Start measurement
'''
ZahnerPP2x2.setVoltageParameter(0)
ZahnerPP2x2.measurePolarization()
```
# 📖 Examples
The application of the library is shown in the example repository [Zahner-Remote-Python](https://github.com/Zahner-elektrik/Zahner-Remote-Python).
# 📧 Having a question?
Send an <a href="mailto:support@zahner.de?subject=Zahner-Remote-Python Question&body=Your Message">e-mail</a> to our support team.
# ⁉️ Found a bug or missing a specific feature?
Feel free to **create a new issue** with a respective title and description on the the [Zahner-Remote-Python](https://github.com/Zahner-elektrik/Zahner-Remote-Python/issues) repository. If you already found a solution to your problem, **we would love to review your pull request**!
# ✅ Requirements
Programming is done with the latest python version at the time of commit.
The only mandatory library is the [pySerial](https://pyserial.readthedocs.io/en/latest/) library. Also numpy and matplotlib are needed if you want to plot the data.
Raw data
{
"_id": null,
"home_page": null,
"name": "zahner-potentiostat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "potentiostat, electrochemistry, chemistry, eis, cyclic voltammetry, fuel-cell, battery",
"author": null,
"author_email": "Maximilian Krapp <maximilian.krapp@zahner.de>",
"download_url": "https://files.pythonhosted.org/packages/30/ea/bb8c64b8f68066af3ba40037114788702129631d3a8ed67c1a45810a6fad/zahner_potentiostat-1.1.1.tar.gz",
"platform": null,
"description": "# zahner_potentiostat\n\nzahner_potentiostat is a library to control external [Zahner Potentiostats](https://zahner.de/products#external-potentiostats) like **PP212, PP222, PP242, XPOT2 or EL1002**.\n\nIt was developed to **easily integrate** external Zahner Potentiostats into Python scripts for more **complex measurement** tasks and for **automation purposes**.\n\nThe control concept is that there are different primitives which can be combined for different electrochemical measurement methods. \nThese primitives can all be configured differently to match the application. In the documentation in the respective function all possible configuration setter methods are listed. The complete documentation of the functions can be found on the [API documentation website](https://doc.zahner.de/zahner_potentiostat/). \n\n> [!NOTE] \n> **Only with this library and a PP212, PP222, PP242, EL1002 or XPOT2 device you can not use AC methods. For AC methods like EIS a [Zennium](https://zahner.de/products#potentiostats) with [EPC](https://zahner.de/products-details/addon-cards/epc42) and the [thales_remote](https://github.com/Zahner-elektrik/Thales-Remote-Python) library is necessary.**\n\n**The following [primitives](https://en.wikipedia.org/wiki/Language_primitive) are available to compose methods with:** \n\n* Potentiostatic or galvanostatic polarization \n * [measurePolarization()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measurePolarization) \n* Open circuit voltage/potential scan \n * [measureOCV()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureOCV) \n * [measureOCVScan()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureOCVScan) \n* Ramps potentiostatic or galvanostatic \n * [measureRampValueInTime()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureRampValueInTime) \n * [measureRampValueInScanRate()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureRampValueInScanRate) \n * [measureRampScanRateForTime()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureRampScanRateForTime) \n* Staircase potentiostatic or galvanostatic \n * [measureIEStairs()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureIEStairs) \n \n**And as an example, the following methods were developed from the primitives:** \n\n* Charge or discharge something \n * [measureCharge()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureCharge) \n * [measureDischarge()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureDischarge) \n* Output potentiostatic or galvanostatic profile as potentiostatic or galvanostatic polarizations or ramps \n * [measureProfile()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureProfile) \n* PITT Potentiostatic Intermittent Titration Technique \n * [measurePITT()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measurePITT) \n* GITT Galvanostatic Intermittent Titration Technique \n * [measureGITT()](https://doc.zahner.de/zahner_potentiostat/scpi_control/control.html#zahner_potentiostat.scpi_control.control.SCPIDevice.measureGITT) \n\nFurther measurements like EIS and CV can be done in connection with a Zennium with the package [thales_remote](https://github.com/Zahner-elektrik/Thales-Remote-Python).\n\n# \ud83d\udd27 Installation\n\nThe package can be installed via pip.\n\n```\npip install zahner_potentiostat\n```\n\n# \ud83d\udd28 Basic Usage\n\n```python\n\n'''\nSearch the Zahner Potentiostat\n'''\ndeviceSearcher = SCPIDeviceSearcher()\ndeviceSearcher.searchZahnerDevices()\ncommandSerial, dataSerial = deviceSearcher.selectDevice(\"35000\")\n\n'''\nConnect to the Potentiostat\n'''\nZahnerPP2x2 = SCPIDevice(SerialCommandInterface(commandSerial), SerialDataInterface(dataSerial))\n\n'''\nSetup measurement\n'''\nZahnerPP2x2.setSamplingFrequency(25)\nZahnerPP2x2.setCoupling(COUPLING.POTENTIOSTATIC)\nZahnerPP2x2.setMaximumTimeParameter(15)\n\n'''\nStart measurement\n'''\nZahnerPP2x2.setVoltageParameter(0)\nZahnerPP2x2.measurePolarization()\n```\n\n# \ud83d\udcd6 Examples\n\nThe application of the library is shown in the example repository [Zahner-Remote-Python](https://github.com/Zahner-elektrik/Zahner-Remote-Python).\n\n# \ud83d\udce7 Having a question?\n\nSend an <a href=\"mailto:support@zahner.de?subject=Zahner-Remote-Python Question&body=Your Message\">e-mail</a> to our support team.\n\n# \u2049\ufe0f Found a bug or missing a specific feature?\n\nFeel free to **create a new issue** with a respective title and description on the the [Zahner-Remote-Python](https://github.com/Zahner-elektrik/Zahner-Remote-Python/issues) repository. If you already found a solution to your problem, **we would love to review your pull request**!\n\n# \u2705 Requirements\n\nProgramming is done with the latest python version at the time of commit. \nThe only mandatory library is the [pySerial](https://pyserial.readthedocs.io/en/latest/) library. Also numpy and matplotlib are needed if you want to plot the data.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Zahner-Elektrik Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Library to control Zahner Potentiostats.",
"version": "1.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/Zahner-elektrik/zahner_potentiostat/issues",
"Documentation": "https://doc.zahner.de/zahner_potentiostat",
"Examples": "https://github.com/Zahner-elektrik/Zahner-Remote-Python",
"Homepage": "https://zahner.de/",
"Source Code": "https://github.com/Zahner-elektrik/zahner_potentiostat"
},
"split_keywords": [
"potentiostat",
" electrochemistry",
" chemistry",
" eis",
" cyclic voltammetry",
" fuel-cell",
" battery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbd473b4e68d123f91f809e271fb21840b288ea04e7d3ef04e217e4b4db3aa6c",
"md5": "cf85806696afc40e6497d371c63d22d4",
"sha256": "f128f1c883256c781ff24e2e5a677424dff2f6a2a3d299c52c62bbfbb089dd33"
},
"downloads": -1,
"filename": "zahner_potentiostat-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf85806696afc40e6497d371c63d22d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 57024,
"upload_time": "2024-05-24T05:49:48",
"upload_time_iso_8601": "2024-05-24T05:49:48.352053Z",
"url": "https://files.pythonhosted.org/packages/cb/d4/73b4e68d123f91f809e271fb21840b288ea04e7d3ef04e217e4b4db3aa6c/zahner_potentiostat-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30eabb8c64b8f68066af3ba40037114788702129631d3a8ed67c1a45810a6fad",
"md5": "b0c0e17e6d9d3b128b17d3362c5c854f",
"sha256": "1b3960c14735982aa4bdfb5603b758775711516b4180939fb34cc0ac453e8b3a"
},
"downloads": -1,
"filename": "zahner_potentiostat-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b0c0e17e6d9d3b128b17d3362c5c854f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 52647,
"upload_time": "2024-05-24T05:49:50",
"upload_time_iso_8601": "2024-05-24T05:49:50.181134Z",
"url": "https://files.pythonhosted.org/packages/30/ea/bb8c64b8f68066af3ba40037114788702129631d3a8ed67c1a45810a6fad/zahner_potentiostat-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-24 05:49:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zahner-elektrik",
"github_project": "zahner_potentiostat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zahner-potentiostat"
}
