Metadata-Version: 2.4
Name: EC4py
Version: 0.7.0
Summary: A package for data treatment of electrochemical data generated by EC4 DAQ. 
Project-URL: Homepage, https://nordicec.github.io/EC4py/
Project-URL: Documentation, https://nordicec.github.io/EC4py/
Project-URL: Repository, https://github.com/nordicec/EC4py
Project-URL: Issues, https://github.com/nordicec/EC4py/issues
Project-URL: Changelog, https://github.com/NordicEC/EC4py/blob/main/CHANGELOG.md
Author-email: Gustav Wiberg <g.wiberg@nordicec.com>
Maintainer-email: Gustav Wiberg <g.wiberg@nordicec.com>
License: MIT License
        
        Copyright (c) 2024 Gustav Wiberg
        
        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.
License-File: LICENSE
Keywords: EC4,Nordic Electorchemistry,electorchemistry,python,tdms
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.08
Requires-Dist: matplotlib
Requires-Dist: nptdms
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pathlib
Requires-Dist: scipy
Description-Content-Type: text/markdown

The intention
---------------
This is a package to be used to treat electrochemical data in order to extract key values such as ECSA and Tafel slopes. Specifically, its aim is to make the data analysis as quick, transparent and easy as possible. 

#  EC4py Docs
The documentation can be found here:
    [https://nordicec.github.io/EC4py](https://nordicec.github.io/EC4py/)
    
# Using EC4py

Get the stable version of EC4py from the Python package index with

```bash
python -m pip install EC4py --upgrade
```
or in a jupyter notebook
```jupyther
%pip install EC4py --upgrade
```




A simple example
---------------
.. code:: python
    
    from EC4py import EC_Data

    data = EC_Data("FILE PATH")
    data.plot("E","i")

Features
--------

* Read TDMS files.
    * Plot

*   Treats cyclic voltammetry(CV) data:
    * subtraction, addition
    * back ground subtraction 
    * Levich analysis
    * Koutechy-Levich analysis

