This package can be used to take cyclic voltammetry data, clean and plot the data, and find and fit peaks to obtain peak locations. It also creates baseline and based on peak location, and calculates the peak current and voltage. Finally use those descriptors to classify a battery material as either electrochemically reversable or not, also to determine if it is an anolyte or catholyte. Additionally, there is a GUI based visualization app that can be used to upload the users data, choose the plotting style and color. This package could be expanded upon to be able to handle different formats of data. For a more specific overview of the project, please see the usecase under docs.
- Python3
- For python packages see requirements.txt
- matplotlib is another required package but cannot be included in the requirements.txt file because there are issues with pip installion on Mac OS X. Instead, matplotlib should be conda installed separately from the installation of the voltcycle package. version 3.0.3 will work with this package.
- hdhh
=======
app/
data/
voltcycle/
core.py
tests/
__init__.py
file_read.py
baseline.py
calculations.py
peak_detection_fxn.py
docs/
Technology_review.pptx
over_view.md
usecases.md
voltcycle_poster.pdf
images/
logo.png
example.png
dash_interface.png
workflow.png
LICENSE
README.md
requirements.txt(FOR DEPENDENCIES)
setup.py
The example usage of the functions are shown in example folder ipython notebook. User can use functions in ipython notebook to analyze their data without DASH interface. User can also obtain high quality images using example.ipynb. Here is an example image: After install the requirements, user can use dash interface for more interactive data visualization. Users can upload raw cyclc voltammetry data, the app then will plot the cv plots with peaks and baseline included. Under the plots all the calculated values and classification of electrolyte are shown in table format. User can download the plots using right click save figure.
See our poster for the quarter summary here
This package is still under development. If you have any questions please email authors.