# Pypotato library
Welcome to the pypotato GitHub repository. Pypotato is an open source Python
API to control commercially available potentiostats. It enables researchers to
write Python scripts that can include experimentation, immediate data analysis
using any third-party library and/or the control of other instruments. Pypotato
facilitates the standardization of electrochemical experiments by keeping a
record of the experiments and data analysis that can be later run again to ensure
repeatability. It also facilitates the sharing of electrochemical protocols
between researchers and groups that own different potentiostats.
Currently, the following potentiostats are included in the library:
* CHI1205B from CH Instruments (chi1205b)
* CHI1242B from CH Instruments (chi1242b)
* CHI601E from CH Instruments (chi601e)
* CHI760E from CH Instruments (chi760e)
* Emstat Pico from PalmSens (emstatpico)
with the following techniques:
* Cyclic voltammetry, CV
* Chronoamperometry, CA
* Linear sweep voltammetry, LSV
* Open circuit potential, OCP
For the CHI601E and CHI760E only:
* Normal pulse voltammetry, NPV
# Installation
Open a console and type:
```python
pip install pypotato
```
# Example: techniques
Here are quick examples on how to use the library. For more help check the [Wiki](https://github.com/jrlLAB/pypotato/wiki).
```python
import pypotato as pp
# Potentiostat setup
# Choose the correct model from ['chi760e', 'chi1205b', 'emstatpico']:
model = 'chi760e'
# Write the path where the chi software is installed (this line is optional when
# using the Pico). Make sure to use / instead of \:
path = 'C:/Users/jrl/CHI/chi760e.exe' # This is ignored for the Pico
# Write the path where the data and plots are going to be automatically saved:
folder = 'C:/Users/jrl/Experiments/data'
# Setup:
pp.potentiostat.Setup(model, path, folder)
# Run CV with default values:
cv = pp.potentiostat.CV()
#cv.bipot() # uncomment to activate second working electrode
cv.run()
# Run a LSV with default values:
lsv = pp.potentiostat.LSV()
#lsv.bipot() # uncomment to activate second working electrode
lsv.run()
# Run a CA with default values:
ca = pp.potentiostat.CA()
#ca.bipot() # uncomment to activate second working electrode
ca.run()
# Run an OCP with default values:
ocp = pp.potentiostat.OCP()
ocp.run()
```
# Notes for CH Instruments users
* Since the CHI potentiostat software only works in Windows, any script written with
pypotato will only work in Windows.
* The CHI translators use macro commands that are only available in the most
recent versions of the software. Please contact CHI support for help on updating
the potentiostat software and firmware.
# Notes for Emstat Pico users
* Contact PalmSens for instructions on how to update the firmware of the Pico.
* The communication to the Pico is done via the serial port, this means that no
external software is required. Because of this, there is no live plotting, however,
the data and plots are saved when the measurement is finished.
* Scripts written for the pico may also work in other operating systems, provided
the library is installed correctly. So far, pypotato with the Pico has been
tested in Windows 10 and Manjaro Linux with kernel 5.15.xx; it has not been tested
with MacOS although it should work.
# Requirements
* numpy for data handling
* matplotlib for plotting
* scipy for fitting
* pyserial for serial handling
* [softpotato](https://github.com/oliverrdz/softpotato) for electrochemical equations and simulations
# Acknowledgements
* To CH Instruments for making their software flexible enough that it can be
started from the Windows command line and for creating the Macros.
* To PalmSens for developing MethodScript and writing code for parsing data. The
code is in the [PalmSens MethodScript GitHub account](https://github.com/PalmSens/MethodSCRIPT_Examples).
* This development is funded by the Joint Center for Energy Storage Research ([JCESR](https://www.jcesr.org/)).
# Authors
Pypotato was developed at the [Beckman Institute](https://beckman.illinois.edu/), University of Illinois at Urbana-Champaign, 2021-2023 by:
* Lead: Oliver Rodriguez ([oliverrdz.xyz](https://oliverrdz.xyz))
* Support: Michael Pence (mapence2@illinois.edu)
* PI: Joaquin Rodriguez-Lopez (joaquinr@illinois.edu)
Raw data
{
"_id": null,
"home_page": "https://github.com/jrlLAB/pypotato",
"name": "pypotato",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Electrochemistry",
"author": "Oliver Rodriguez",
"author_email": "oliver.rdz@softpotato.xyz",
"download_url": "https://files.pythonhosted.org/packages/81/45/f297976ab90fe4b07db6a75ef8c1fdec4d054ba4260f20820ce1ab0303ae/pypotato-1.3.6.tar.gz",
"platform": null,
"description": "# Pypotato library\nWelcome to the pypotato GitHub repository. Pypotato is an open source Python\nAPI to control commercially available potentiostats. It enables researchers to\nwrite Python scripts that can include experimentation, immediate data analysis\nusing any third-party library and/or the control of other instruments. Pypotato\nfacilitates the standardization of electrochemical experiments by keeping a \nrecord of the experiments and data analysis that can be later run again to ensure \nrepeatability. It also facilitates the sharing of electrochemical protocols \nbetween researchers and groups that own different potentiostats. \n\nCurrently, the following potentiostats are included in the library:\n\n* CHI1205B from CH Instruments (chi1205b)\n* CHI1242B from CH Instruments (chi1242b)\n* CHI601E from CH Instruments (chi601e)\n* CHI760E from CH Instruments (chi760e)\n* Emstat Pico from PalmSens (emstatpico)\n\nwith the following techniques:\n* Cyclic voltammetry, CV\n* Chronoamperometry, CA\n* Linear sweep voltammetry, LSV\n* Open circuit potential, OCP\n\nFor the CHI601E and CHI760E only:\n* Normal pulse voltammetry, NPV\n\n# Installation\nOpen a console and type:\n```python\npip install pypotato\n```\n\n# Example: techniques\nHere are quick examples on how to use the library. For more help check the [Wiki](https://github.com/jrlLAB/pypotato/wiki).\n\n```python\nimport pypotato as pp\n\n# Potentiostat setup\n# Choose the correct model from ['chi760e', 'chi1205b', 'emstatpico']:\nmodel = 'chi760e' \n# Write the path where the chi software is installed (this line is optional when\n# using the Pico). Make sure to use / instead of \\:\npath = 'C:/Users/jrl/CHI/chi760e.exe' # This is ignored for the Pico\n# Write the path where the data and plots are going to be automatically saved:\nfolder = 'C:/Users/jrl/Experiments/data'\n# Setup:\npp.potentiostat.Setup(model, path, folder)\n\n# Run CV with default values:\ncv = pp.potentiostat.CV()\n#cv.bipot() # uncomment to activate second working electrode\ncv.run()\n\n# Run a LSV with default values:\nlsv = pp.potentiostat.LSV()\n#lsv.bipot() # uncomment to activate second working electrode\nlsv.run()\n\n# Run a CA with default values:\nca = pp.potentiostat.CA()\n#ca.bipot() # uncomment to activate second working electrode\nca.run()\n\n# Run an OCP with default values:\nocp = pp.potentiostat.OCP()\nocp.run()\n```\n\n# Notes for CH Instruments users\n* Since the CHI potentiostat software only works in Windows, any script written with\npypotato will only work in Windows.\n* The CHI translators use macro commands that are only available in the most \nrecent versions of the software. Please contact CHI support for help on updating\nthe potentiostat software and firmware.\n\n# Notes for Emstat Pico users\n* Contact PalmSens for instructions on how to update the firmware of the Pico.\n* The communication to the Pico is done via the serial port, this means that no\nexternal software is required. Because of this, there is no live plotting, however,\nthe data and plots are saved when the measurement is finished.\n* Scripts written for the pico may also work in other operating systems, provided\nthe library is installed correctly. So far, pypotato with the Pico has been \ntested in Windows 10 and Manjaro Linux with kernel 5.15.xx; it has not been tested \nwith MacOS although it should work. \n\n# Requirements\n* numpy for data handling\n* matplotlib for plotting\n* scipy for fitting\n* pyserial for serial handling\n* [softpotato](https://github.com/oliverrdz/softpotato) for electrochemical equations and simulations\n\n# Acknowledgements\n* To CH Instruments for making their software flexible enough that it can be \nstarted from the Windows command line and for creating the Macros.\n* To PalmSens for developing MethodScript and writing code for parsing data. The\ncode is in the [PalmSens MethodScript GitHub account](https://github.com/PalmSens/MethodSCRIPT_Examples).\n* This development is funded by the Joint Center for Energy Storage Research ([JCESR](https://www.jcesr.org/)).\n\n# Authors\nPypotato was developed at the [Beckman Institute](https://beckman.illinois.edu/), University of Illinois at Urbana-Champaign, 2021-2023 by:\n\n* Lead: Oliver Rodriguez ([oliverrdz.xyz](https://oliverrdz.xyz))\n* Support: Michael Pence (mapence2@illinois.edu)\n* PI: Joaquin Rodriguez-Lopez (joaquinr@illinois.edu)\n",
"bugtrack_url": null,
"license": "",
"summary": "Python API to control programmable potentiostats.",
"version": "1.3.6",
"split_keywords": [
"electrochemistry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8145f297976ab90fe4b07db6a75ef8c1fdec4d054ba4260f20820ce1ab0303ae",
"md5": "84b1e16678547fb27d08633fa73e5b7c",
"sha256": "ce04cd03f64aba83187fd69aa6c0014a74238994d162c3ae062748629e355d95"
},
"downloads": -1,
"filename": "pypotato-1.3.6.tar.gz",
"has_sig": false,
"md5_digest": "84b1e16678547fb27d08633fa73e5b7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32620,
"upload_time": "2023-01-04T19:48:28",
"upload_time_iso_8601": "2023-01-04T19:48:28.289137Z",
"url": "https://files.pythonhosted.org/packages/81/45/f297976ab90fe4b07db6a75ef8c1fdec4d054ba4260f20820ce1ab0303ae/pypotato-1.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-04 19:48:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jrlLAB",
"github_project": "pypotato",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pypotato"
}
JSON
