# PYVIUM
Tiny Python wrapper around the "Software development driver DLL" for IviumSoft.
# Important:
This module uses a dll from the IviumSoft application. You need to have this software installed on a Windows machine. The IviumSoft application can be downloaded from here: https://www.ivium.com/support/#Software%20update
This version of Pyvium has been tested for IviumSoft release 4.1100.
## Installation
Install PYVIUM easily with pip:
```
pip install pyvium
```
Or with poetry:
```
poetry add pyvium
```
## Usage Example (Using IviumSoft Core functions)
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()
```
## Usage Example (Using Pyvium methods)
This is a wrapper around the Core functions that adds a few things:
- Exception management (you can find an example [here](https://github.com/SF-Tec/pyvium/blob/main/docs/error_management.md))
- New functionalities
```
from pyvium import Pyvium
Pyvium.open_driver()
Pyvium.get_device_status()
Pyvium.close_driver()
```
## Usage Example (Using Tools methods)
This offers further functionality in data processing:
```
from pyvium import Tools
Tools.convert_idf_dir_to_csv()
```
## Supported functions
The list of currently supported and implemented functions can be found [here](https://github.com/SF-Tec/pyvium/blob/main/docs/method_list.md).
## Links
- [See on GitHub](https://github.com/sf-tec/pyvium)
- [See on PyPI](https://pypi.org/project/pyvium)
Raw data
{
"_id": null,
"home_page": "https://github.com/SF-Tec/pyvium",
"name": "pyvium",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "ivium,iviumsoft,ivium software,ivium compactstat",
"author": "Alejandro Guti\u00e9rrez",
"author_email": "agutierrez@stec.es",
"download_url": "https://files.pythonhosted.org/packages/1c/7b/7c12f1fad440e7b25cb95895c31f2361dc321aea3214b195f5c884b618c4/pyvium-0.1.18b0.tar.gz",
"platform": null,
"description": "# PYVIUM\n\nTiny Python wrapper around the \"Software development driver DLL\" for IviumSoft.\n\n# Important:\n\nThis module uses a dll from the IviumSoft application. You need to have this software installed on a Windows machine. The IviumSoft application can be downloaded from here: https://www.ivium.com/support/#Software%20update\n\nThis version of Pyvium has been tested for IviumSoft release 4.1100.\n\n## Installation\n\nInstall PYVIUM easily with pip:\n\n```\npip install pyvium\n```\n\nOr with poetry:\n\n```\npoetry add pyvium\n```\n\n## Usage Example (Using IviumSoft Core functions)\n\nTo 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.\n\n```\nfrom pyvium import Core\n\nCore.IV_open()\nCore.IV_getdevicestatus()\nCore.IV_close()\n```\n\n## Usage Example (Using Pyvium methods)\n\nThis is a wrapper around the Core functions that adds a few things:\n\n- Exception management (you can find an example [here](https://github.com/SF-Tec/pyvium/blob/main/docs/error_management.md))\n- New functionalities\n\n```\nfrom pyvium import Pyvium\n\nPyvium.open_driver()\nPyvium.get_device_status()\nPyvium.close_driver()\n\n```\n## Usage Example (Using Tools methods)\n\nThis offers further functionality in data processing:\n\n\n```\nfrom pyvium import Tools\n\nTools.convert_idf_dir_to_csv()\n\n```\n\n## Supported functions\n\nThe list of currently supported and implemented functions can be found [here](https://github.com/SF-Tec/pyvium/blob/main/docs/method_list.md).\n\n## Links\n\n- [See on GitHub](https://github.com/sf-tec/pyvium)\n- [See on PyPI](https://pypi.org/project/pyvium)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A tiny Python wrapper around the <Software development driver DLL> for IviumSoft.",
"version": "0.1.18b0",
"project_urls": {
"Homepage": "https://github.com/SF-Tec/pyvium",
"Repository": "https://github.com/SF-Tec/pyvium"
},
"split_keywords": [
"ivium",
"iviumsoft",
"ivium software",
"ivium compactstat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1bf4299d665a45cf02d69656b6646fea50b2759e0d14de383c54596345a30f0e",
"md5": "4b9f142ca0cdc0c5f40f4bab73a0813b",
"sha256": "cf4cda8a83472b80952a2e60c14808347dbe00a7bea63666b3da7b0973ad6efb"
},
"downloads": -1,
"filename": "pyvium-0.1.18b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b9f142ca0cdc0c5f40f4bab73a0813b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 2284521,
"upload_time": "2024-01-22T12:30:24",
"upload_time_iso_8601": "2024-01-22T12:30:24.650003Z",
"url": "https://files.pythonhosted.org/packages/1b/f4/299d665a45cf02d69656b6646fea50b2759e0d14de383c54596345a30f0e/pyvium-0.1.18b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c7b7c12f1fad440e7b25cb95895c31f2361dc321aea3214b195f5c884b618c4",
"md5": "7190eed38e2c3097a6f80a358b571408",
"sha256": "a1826c3fbf1eb7bc306e41553dc9440feba6bd4780ef8013265a39342722f5ac"
},
"downloads": -1,
"filename": "pyvium-0.1.18b0.tar.gz",
"has_sig": false,
"md5_digest": "7190eed38e2c3097a6f80a358b571408",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 2261653,
"upload_time": "2024-01-22T12:30:37",
"upload_time_iso_8601": "2024-01-22T12:30:37.154264Z",
"url": "https://files.pythonhosted.org/packages/1c/7b/7c12f1fad440e7b25cb95895c31f2361dc321aea3214b195f5c884b618c4/pyvium-0.1.18b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 12:30:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SF-Tec",
"github_project": "pyvium",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyvium"
}