Metadata-Version: 2.4
Name: PyPalmSens
Version: 1.8.0
Summary: Python SDK for PalmSens instruments
Author-email: Palmsens BV <info@palmsens.com>
License-Expression: LicenseRef-Modified-BSD-3-Clause-PalmSens
Project-URL: homepage, https://github.com/palmsens/palmsens_sdk
Project-URL: issues, https://github.com/palmsens/palmsens_sdk/issues
Project-URL: documentation, https://dev.palmsens.com/python/latest/_attachments/index.html
Project-URL: changelog, https://github.com/palmsens/palmsens_sdk/releases
Keywords: electrochemistry,data-analysis,voltammetry,potentiometry,impedance-specroscopy
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic
Requires-Dist: numpy
Requires-Dist: pythonnet
Requires-Dist: typing-extensions
Provides-Extra: develop
Requires-Dist: bump-my-version; extra == "develop"
Requires-Dist: coverage; extra == "develop"
Requires-Dist: griffe2md; extra == "develop"
Requires-Dist: pre-commit; extra == "develop"
Requires-Dist: pytest; extra == "develop"
Requires-Dist: pytest-asyncio; extra == "develop"
Provides-Extra: publishing
Requires-Dist: twine; extra == "publishing"
Requires-Dist: wheel; extra == "publishing"
Requires-Dist: build; extra == "publishing"
Provides-Extra: docs
Requires-Dist: zensical>=0.0.20; extra == "docs"
Requires-Dist: mkdocstrings>=1.0.1; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Dynamic: license-file

[![Tests](https://github.com/PalmSens/PalmSens_SDK/actions/workflows/python-tests.yml/badge.svg)](https://github.com/PalmSens/PalmSens_SDK/actions/workflows/python-tests.yml)
![Coverage](https://img.shields.io/badge/coverage-87%25-brightgreen)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypalmsens)](https://pypi.org/project/pypalmsens/)
[![PyPI](https://img.shields.io/pypi/v/pypalmsens.svg?style=flat)](https://pypi.org/project/pypalmsens/)

<br>

<p align="center">
    <a href="https://dev.palmsens.com/python/latest" target="_blank">
        <picture>
          <source media="(prefers-color-scheme: dark)" srcset="./docs/zensical/assets//banner_dark.svg">
          <source media="(prefers-color-scheme: light)" srcset="./docs/zensical/assets//banner.svg">
          <img alt="PalmSens banner" src="./docs/zensical/assets//banner.svg" width="80%">
        </picture>
    </a>
</p>

<br>

# PyPalmSens: Python SDK for PalmSens devices

PyPalmSens is a Python library for automating electrochemistry experiments with your PalmSens instruments.
It provides an intuitive Python API, making it straightforward to integrate into your Python workflows.

With PyPalmSens, you can:

- Connect to [one](https://dev.palmsens.com/python/latest/_attachments/measuring/#connecting-to-a-device) or [more](https://dev.palmsens.com/python/latest/_attachments/measuring/#multichannel-measurements) instruments/channels
- Automate [electrochemistry measurements](https://dev.palmsens.com/python/latest/_attachments/methods)
- [Read and write method and data files](https://dev.palmsens.com/python/latest/_attachments/files)
- [Access, process, and analyze](https://dev.palmsens.com/python/latest/_attachments/data) measured data
- Perform [peak detection](https://dev.palmsens.com/python/latest/_attachments/reference/data/#pypalmsens.data.Curve.find_peaks)
- Do [Equivalent Circuit Fitting](https://dev.palmsens.com/python/latest/_attachments/circuit_fitting) on impedance data
- Take [manual control](https://dev.palmsens.com/python/latest/_attachments/examples/#manual-control) of the cell

To install:

```python
pip install pypalmsens
```

PyPalmSens is built on top of the included [PalmSens .NET libraries](https://dev.palmsens.com/dotnet/api/core.html), and therefore requires the .NET runtime to be installed.

For specific installation instructions for your platform, see the
[documentation](https://dev.palmsens.com/python/latest/_attachments/index.html).
