| Name | zahner-analysis JSON |
| Version |
1.1.4
JSON |
| download |
| home_page | None |
| Summary | Python package for the analysis of electrochemical impedance spectra. |
| upload_time | 2024-09-16 06:12:42 |
| 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_analysis](zahner_analysis) is a Python package which uses the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) to evaluate measured electrochemical data.
The Python package [zahner_analysis](zahner_analysis) is a client for the [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) of the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) module *Remote Evaluation*. This module is optional and must be [selected for installation](https://doc.zahner.de/zahner_analysis/analysis_connection.html#basic-informations) when installing the Zahner Analysis.
A equivalent electrical circuit model for an impedance measurement can be easily developed with the graphical interface of the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis). The *Magic Wand Preset Element Tool* tool is available to determine appropriate initial values for the fit.
With Python the equivalent electrical circuit models, which have been created with the GUI, can be fitted to impedance spectra.
The elements and parameters of the model can be read and processed with Python.
With the Python package [thales_remote](https://github.com/Zahner-elektrik/Thales-Remote-Python) as a supplement, EIS measurements can be performed with a Zennium and immediately evaluated. The [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) is not required for importing and plotting data with Python.
Additional features are the import of measurement data for CV and I/E measurements (isc and iss files). For this the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) is not necessary.
# 📚 Documentation
## Python Package
The complete documentation of the individual functions can be found on the [API documentation website](https://doc.zahner.de/zahner_analysis/).
## REST-API
The REST-API was documented using OpenAPI. The configuration [file](openapi.yaml) is in the repository and the generated html page can be found at the following [url](https://doc.zahner.de/zahner_analysis/analysis_remote.html).
# 🔧 Installation
The package can be installed via pip.
```text
pip install zahner_analysis
```
The [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) must be downloaded from the [Zahner-Elektrik website](https://zahner.de/products-details/software/Zahner-Analysis) in order to be installed.
# 🔨 Basic Usage
The [Jupyter](https://jupyter.org/) notebook [BasicIntroduction.ipynb](Examples/BasicIntroduction/BasicIntroduction.ipynb) explains the fundamentals of using the library.
```python
"""
Load data and model
"""
impedanceCircuitModel = IsfxModelImport("li-ion-model.isfx")
impedanceData = IsmImport("li-ion-battery.ism")
"""
Create the EisFitting object
"""
fitting = EisFitting()
"""
Fit the equivalent electrical circuit model to the data
"""
fittingResult = fitting.fit(impedanceCircuitModel, impedanceData)
"""
Plot the result
"""
EisFittingPlotter.plotBode(fittingResult)
```
# 📖 Examples
The following examples are build on each other, you should read and understand them in sequence.
If measurement data are saved from the examples, they are located in the corresponding directory of the example.
## [BasicIntroduction.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/BasicIntroduction/BasicIntroduction.ipynb)
* Load the data and the model
* Fit the model to the data
* Plot the result
## [ComplexFitConfigurations.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/ComplexFitConfigurations/ComplexFitConfigurations.ipynb)
* Showing all configuration options
* Customize the connection to Zahner Analysis Software
* Optional fit and simulation parameters
* Optional plotting parameters
## [ImpedanceVsVoltageSeriesFit.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/ImpedanceVsVoltageSeriesFit/ImpedanceVsVoltageSeriesFit.ipynb)
* EIS series fit
* Load all files from a directory
* Plot circuit element vs series parameter
## [ZHIT.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/ZHIT/ZHIT.ipynb)
* Fit the model to the data
* Load the data and the model
* Perform ZHIT evaluation
* Plot the result
## [SetupCompensation.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/SetupCompensation/SetupCompensation.ipynb)
* Apply Short-Open-Load correction to EIS data
# 📧 Having a question?
Send an [mail](mailto:support@zahner.de?subject=Zahner-Analysis-Python%20Question&body=Your%20Message) 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-Analysis-Python](https://github.com/Zahner-elektrik/Zahner-Analysis-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.
If you work with equivalent circuits and you need the fit and simulate functions, you need the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) with its REST interface. To use the REST interface, you need a licensed [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) with at least version **3.2.1**. The [Zahner Analysis Software](https://zahner.de/products-details/software/Zahner-Analysis) is **not required for importing and plotting** data.
The packages [matplotlib](https://matplotlib.org/), [SciPy](https://scipy.org/) and [NumPy](https://numpy.org/) are used to display the measurement results. The [requests package](https://pypi.org/project/requests/) is necessary to communicate with the Zahner Analysis. Jupyter is not necessary, each example is also available as a Python file.
Raw data
{
"_id": null,
"home_page": null,
"name": "zahner-analysis",
"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/8f/b7/4b45538984657e8b2243124e0ed9f389ca88387b90b1045a90570649d908/zahner_analysis-1.1.4.tar.gz",
"platform": null,
"description": "\n\n[zahner_analysis](zahner_analysis) is a Python package which uses the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) to evaluate measured electrochemical data.\n\nThe Python package [zahner_analysis](zahner_analysis) is a client for the [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) of the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) module *Remote Evaluation*. This module is optional and must be [selected for installation](https://doc.zahner.de/zahner_analysis/analysis_connection.html#basic-informations) when installing the Zahner Analysis.\n\nA equivalent electrical circuit model for an impedance measurement can be easily developed with the graphical interface of the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis). The *Magic Wand Preset Element Tool* tool is available to determine appropriate initial values for the fit.\n\n\n\nWith Python the equivalent electrical circuit models, which have been created with the GUI, can be fitted to impedance spectra.\nThe elements and parameters of the model can be read and processed with Python.\n\nWith the Python package [thales_remote](https://github.com/Zahner-elektrik/Thales-Remote-Python) as a supplement, EIS measurements can be performed with a Zennium and immediately evaluated. The [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) is not required for importing and plotting data with Python.\n\nAdditional features are the import of measurement data for CV and I/E measurements (isc and iss files). For this the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) is not necessary.\n\n# \ud83d\udcda Documentation\n\n## Python Package\n\nThe complete documentation of the individual functions can be found on the [API documentation website](https://doc.zahner.de/zahner_analysis/).\n\n## REST-API\n\nThe REST-API was documented using OpenAPI. The configuration [file](openapi.yaml) is in the repository and the generated html page can be found at the following [url](https://doc.zahner.de/zahner_analysis/analysis_remote.html).\n\n# \ud83d\udd27 Installation\n\nThe package can be installed via pip.\n\n```text\npip install zahner_analysis\n```\n\nThe [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) must be downloaded from the [Zahner-Elektrik website](https://zahner.de/products-details/software/Zahner-Analysis) in order to be installed.\n\n# \ud83d\udd28 Basic Usage\n\nThe [Jupyter](https://jupyter.org/) notebook [BasicIntroduction.ipynb](Examples/BasicIntroduction/BasicIntroduction.ipynb) explains the fundamentals of using the library.\n\n```python\n\"\"\"\nLoad data and model\n\"\"\"\nimpedanceCircuitModel = IsfxModelImport(\"li-ion-model.isfx\")\nimpedanceData = IsmImport(\"li-ion-battery.ism\")\n\n\"\"\"\nCreate the EisFitting object\n\"\"\"\nfitting = EisFitting()\n\n\"\"\"\nFit the equivalent electrical circuit model to the data\n\"\"\"\nfittingResult = fitting.fit(impedanceCircuitModel, impedanceData)\n\n\"\"\"\nPlot the result\n\"\"\"\nEisFittingPlotter.plotBode(fittingResult)\n```\n\n\n\n# \ud83d\udcd6 Examples\n\nThe following examples are build on each other, you should read and understand them in sequence.\n\nIf measurement data are saved from the examples, they are located in the corresponding directory of the example.\n\n## [BasicIntroduction.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/BasicIntroduction/BasicIntroduction.ipynb)\n\n* Load the data and the model\n* Fit the model to the data\n* Plot the result\n\n## [ComplexFitConfigurations.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/ComplexFitConfigurations/ComplexFitConfigurations.ipynb)\n\n* Showing all configuration options\n* Customize the connection to Zahner Analysis Software\n* Optional fit and simulation parameters\n* Optional plotting parameters\n\n## [ImpedanceVsVoltageSeriesFit.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/ImpedanceVsVoltageSeriesFit/ImpedanceVsVoltageSeriesFit.ipynb)\n\n* EIS series fit\n* Load all files from a directory\n* Plot circuit element vs series parameter\n\n## [ZHIT.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/ZHIT/ZHIT.ipynb)\n\n* Fit the model to the data\n* Load the data and the model\n* Perform ZHIT evaluation\n* Plot the result\n\n## [SetupCompensation.ipynb](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/blob/main/Examples/SetupCompensation/SetupCompensation.ipynb)\n\n* Apply Short-Open-Load correction to EIS data\n\n# \ud83d\udce7 Having a question?\n\nSend an [mail](mailto:support@zahner.de?subject=Zahner-Analysis-Python%20Question&body=Your%20Message) 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-Analysis-Python](https://github.com/Zahner-elektrik/Zahner-Analysis-Python/issues) repository. \nIf 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.\n\nIf you work with equivalent circuits and you need the fit and simulate functions, you need the [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) with its REST interface. To use the REST interface, you need a licensed [Zahner Analysis](https://zahner.de/products-details/software/Zahner-Analysis) with at least version **3.2.1**. The [Zahner Analysis Software](https://zahner.de/products-details/software/Zahner-Analysis) is **not required for importing and plotting** data.\n\nThe packages [matplotlib](https://matplotlib.org/), [SciPy](https://scipy.org/) and [NumPy](https://numpy.org/) are used to display the measurement results. The [requests package](https://pypi.org/project/requests/) is necessary to communicate with the Zahner Analysis. Jupyter is not necessary, each example is also available as a Python file.\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": "Python package for the analysis of electrochemical impedance spectra.",
"version": "1.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/Zahner-elektrik/Zahner-Analysis-Python/issues",
"Documentation": "https://doc.zahner.de/zahner_analysis",
"Examples": "https://github.com/Zahner-elektrik/Zahner-Analysis-Python/tree/main/Examples",
"Homepage": "https://zahner.de/",
"Source Code": "https://github.com/Zahner-elektrik/Zahner-Analysis-Python"
},
"split_keywords": [
"potentiostat",
" electrochemistry",
" chemistry",
" eis",
" cyclic voltammetry",
" fuel-cell",
" battery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0af296e063d428ce73c10029f1456ac50cfc054e76352f862b4daa7b3a0870a2",
"md5": "23b5c0ccf36df08df22291de9879ecd1",
"sha256": "59c068b3bb2e6189b6d7d6bed94038cfe785a8feaf18ac55dfb19529a0ee24b4"
},
"downloads": -1,
"filename": "zahner_analysis-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23b5c0ccf36df08df22291de9879ecd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 44889,
"upload_time": "2024-09-16T06:12:41",
"upload_time_iso_8601": "2024-09-16T06:12:41.163621Z",
"url": "https://files.pythonhosted.org/packages/0a/f2/96e063d428ce73c10029f1456ac50cfc054e76352f862b4daa7b3a0870a2/zahner_analysis-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8fb74b45538984657e8b2243124e0ed9f389ca88387b90b1045a90570649d908",
"md5": "65c0b683c40cbd2135548eb83f08f1fd",
"sha256": "116818834a182dee527939511373e702af983bb64bd77289a113acf157f4fe1c"
},
"downloads": -1,
"filename": "zahner_analysis-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "65c0b683c40cbd2135548eb83f08f1fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2154495,
"upload_time": "2024-09-16T06:12:42",
"upload_time_iso_8601": "2024-09-16T06:12:42.948991Z",
"url": "https://files.pythonhosted.org/packages/8f/b7/4b45538984657e8b2243124e0ed9f389ca88387b90b1045a90570649d908/zahner_analysis-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 06:12:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zahner-elektrik",
"github_project": "Zahner-Analysis-Python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zahner-analysis"
}
