This release is a pre-release and may not be stable for production use.
PYVIUM
Python wrapper for the IviumSoft driver DLL, enabling control of Ivium potentiostats and data processing directly from Python.
PYVIUM provides both:
- Direct access to the original IviumSoft Core functions
- Higher-level Pythonic interface with exception handling and extended utilities
Features
- Full access to IviumSoft driver DLL functions
- Python-friendly interface
- Exception management
- Data processing tools
- Batch conversion utilities
- Batch mode synchronization
Requirements
PYVIUM requires IviumSoft to be installed on a Windows machine, as it uses the official driver DLL.
Download IviumSoft here:
https://www.ivium.com/support/#Software%20update
This version of PYVIUM contains the DLL from IviumSoft release 4.1247.
Installation
Install PYVIUM easily with pip:
pip install pyvium
Or with poetry:
poetry add pyvium
Quick Start
Using Core functions (direct DLL access)
To use the same functions available in the "IviumSoft driver DLL" you can import the Core class as follows. All functions return a result code (integer) and a result value if available. For further information you can check the IviumSoft documentation.
from pyvium import Core
Core.IV_open()
Core.IV_getdevicestatus()
Core.IV_close()
Using Pyvium high-level interface (recommended)
This is a wrapper around the Core functions that adds a few things:
- Exception management (you can find an example here)
- Cleaner syntax
- Additional functionality
from pyvium import Pyvium
Pyvium.open_driver()
Pyvium.get_device_status()
Pyvium.close_driver()
Data processing tools
This offers further functionality in data processing:
from pyvium import Tools
Tools.convert_idf_dir_to_csv()
Examples & Notebooks
A series of Jupyter notebooks covers the full API:
| Notebook | Topic |
|---|---|
01_getting_started |
Installation, driver lifecycle, error handling |
02_device_and_instance_management |
Connecting devices, switching instances, thread-safe scoping, multichannel |
03_direct_mode_basics |
Potential/current control, cell on/off |
04_direct_mode_signals |
DAC/ADC, digital I/O, AC signal |
05_bipotentiostat_and_we32 |
BiStat WE2 and 32-channel WE32 array |
06_method_mode |
Load, run, monitor, and save experiments |
07_data_processing |
Parse IDF files, export to CSV (no hardware needed) |
08_batch_and_synchronization |
Multi-device setpoints and parallel runs |
09_trigger_reference |
Python–IviumSoft trigger mechanisms |
10_instance_lifecycle_management |
Launch, list, adopt and close IviumSoft instances |
11_sqlite_measurement_readers |
Read IviumSoft's SQLite measurement files (no hardware needed) |
Browse them in the notebooks/ directory.
Implemented functions
The list of currently implemented functions can be found here.
Support and Consulting
If you need help implementing PYVIUM in your application, integrating Ivium instruments, or developing custom workflows, professional consulting is available.
Contact:
You can also support the project via GitHub Sponsors:
https://github.com/sponsors/Gnpd
Sponsors receive priority support and help drive future development.
Links
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyvium-0.3.0rc5.tar.gz.
File metadata
- Download URL: pyvium-0.3.0rc5.tar.gz
- Upload date:
- Size: 2.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45b380116a69a64105ae16ca3e9709485709b3ca2f9e24966f4393c32dc8e9f9
|
|
| MD5 |
33b6f94d06492b79ca762683c98e8888
|
|
| BLAKE2b-256 |
b922b8a36ec8f092420690e941885db0585bc20fa7589ba2f35ef1381e25bd7f
|
Provenance
The following attestation bundles were made for pyvium-0.3.0rc5.tar.gz:
Publisher:
publish.yml on Gnpd/pyvium
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyvium-0.3.0rc5.tar.gz -
Subject digest:
45b380116a69a64105ae16ca3e9709485709b3ca2f9e24966f4393c32dc8e9f9 - Sigstore transparency entry: 2617689148
- Sigstore integration time:
-
Permalink:
Gnpd/pyvium@a39deb12780bf555aa58e2b383cc1e9ab9295685 -
Branch / Tag:
refs/heads/release/0.3.0rc1 - Owner: https://github.com/Gnpd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a39deb12780bf555aa58e2b383cc1e9ab9295685 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file pyvium-0.3.0rc5-py3-none-any.whl.
File metadata
- Download URL: pyvium-0.3.0rc5-py3-none-any.whl
- Upload date:
- Size: 2.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a80199fa2af696ba1c0edc827072585317e00add206cd4424b8572911077e467
|
|
| MD5 |
9f5d99f6510d731e94efbde45b8bb52d
|
|
| BLAKE2b-256 |
13d9cc00c05d25aa300d02688fa41e30ee38a12ba3fba10fa9c81eedf0c5264b
|
Provenance
The following attestation bundles were made for pyvium-0.3.0rc5-py3-none-any.whl:
Publisher:
publish.yml on Gnpd/pyvium
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyvium-0.3.0rc5-py3-none-any.whl -
Subject digest:
a80199fa2af696ba1c0edc827072585317e00add206cd4424b8572911077e467 - Sigstore transparency entry: 2617689151
- Sigstore integration time:
-
Permalink:
Gnpd/pyvium@a39deb12780bf555aa58e2b383cc1e9ab9295685 -
Branch / Tag:
refs/heads/release/0.3.0rc1 - Owner: https://github.com/Gnpd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a39deb12780bf555aa58e2b383cc1e9ab9295685 -
Trigger Event:
workflow_dispatch
-
Statement type:
