| Name | pyIPCMini JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | pyIPCMini is a package to communicate and control via USB/serial the ion pump controller type IPCMini from Agilent. |
| upload_time | 2024-07-21 12:13:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
ipcmini
driver
ion pump
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyIPCMini
pyIPCMini is a package to communicate and control via USB/serial the ion pump controller type IPCMini from Agilent.
It has been tested using the RS232 protocol, with the pump's DB9 connector hooked to a USB-serial converter based on FTDI chip.
This is an unofficial package for the [IPCMini](https://www.agilent.com/en/product/vacuum-technologies/ion-pumps-controllers/ion-pump-controllers/ipcmini-ion-pump-controller) and it is not supported by the equipment's vendor.
## Installation
You can install this package from PyPI, using the following command:
pip install pyIPCMini
Alternatively, you can clone the latest version from github:
git clone https://github.com/benjaminpasquiou/pyIPCMini.git
## Usage
### Python package
For starting using this package, you can see these [useful examples](https://github.com/benjaminpasquiou/pyIPCMini/blob/main/notebooks/Examples.ipynb).
You can also look into the [package documentation](https://pyIPCMini.readthedocs.io).
### Application
For using the application on the command line, to see the help message, you can first use:
pyIPCMini -h
An example of a working command:
pyIPCMini -p "/dev/ttyUSB0" -l "My pump" --show
The application's functionalities are very limited and are just examples for you to build on and obtain something that matches your needs.
You then would have to use a combination of *python -m build -- wheel* and *python -m pip install pyIPCMini-X.X.X-py3-none-any.whl* within the python environment of your choice, to install your own modified version of the application.
## Warning
An ion pump is a sensitive device, and if not used properly it can potentially cause harm to the user, to the device itself, or to other pieces of equipment. This package should only be used by trained operators. Please read Agilent IPCMini's manual and make sure that you can safely operate the pump in manual mode, before using the package for remote control. Please also consult the package's documentation at [https://pyIPCMini.readthedocs.io](https://pyIPCMini.readthedocs.io) before using any of its functionalities. Also, let me reminds you of no-liability statement in the package's [license](https://github.com/benjaminpasquiou/pyIPCMini/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "pyIPCMini",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "IPCMini, driver, ion pump",
"author": null,
"author_email": "Benjamin Pasquiou <benjamin.pasquiou@univ-paris13.fr>",
"download_url": "https://files.pythonhosted.org/packages/60/c7/97b19b3485c5c54e4ddc8831d4736b46de36bb27fe65fd88e2512b4cbe63/pyipcmini-0.1.0.tar.gz",
"platform": null,
"description": "# pyIPCMini\r\n\r\npyIPCMini is a package to communicate and control via USB/serial the ion pump controller type IPCMini from Agilent.\r\n\r\nIt has been tested using the RS232 protocol, with the pump's DB9 connector hooked to a USB-serial converter based on FTDI chip.\r\n\r\nThis is an unofficial package for the [IPCMini](https://www.agilent.com/en/product/vacuum-technologies/ion-pumps-controllers/ion-pump-controllers/ipcmini-ion-pump-controller) and it is not supported by the equipment's vendor.\r\n\r\n## Installation\r\n\r\nYou can install this package from PyPI, using the following command:\r\n\r\n pip install pyIPCMini\r\n\r\nAlternatively, you can clone the latest version from github:\r\n\r\n git clone https://github.com/benjaminpasquiou/pyIPCMini.git\r\n\r\n\r\n## Usage\r\n\r\n### Python package\r\n\r\nFor starting using this package, you can see these [useful examples](https://github.com/benjaminpasquiou/pyIPCMini/blob/main/notebooks/Examples.ipynb).\r\n\r\nYou can also look into the [package documentation](https://pyIPCMini.readthedocs.io).\r\n\r\n### Application\r\n\r\nFor using the application on the command line, to see the help message, you can first use:\r\n\r\n pyIPCMini -h\r\n\r\nAn example of a working command:\r\n\r\n pyIPCMini -p \"/dev/ttyUSB0\" -l \"My pump\" --show\r\n\r\nThe application's functionalities are very limited and are just examples for you to build on and obtain something that matches your needs.\r\nYou then would have to use a combination of *python -m build -- wheel* and *python -m pip install pyIPCMini-X.X.X-py3-none-any.whl* within the python environment of your choice, to install your own modified version of the application.\r\n\r\n## Warning\r\n\r\nAn ion pump is a sensitive device, and if not used properly it can potentially cause harm to the user, to the device itself, or to other pieces of equipment. This package should only be used by trained operators. Please read Agilent IPCMini's manual and make sure that you can safely operate the pump in manual mode, before using the package for remote control. Please also consult the package's documentation at [https://pyIPCMini.readthedocs.io](https://pyIPCMini.readthedocs.io) before using any of its functionalities. Also, let me reminds you of no-liability statement in the package's [license](https://github.com/benjaminpasquiou/pyIPCMini/blob/main/LICENSE).\r\n",
"bugtrack_url": null,
"license": null,
"summary": "pyIPCMini is a package to communicate and control via USB/serial the ion pump controller type IPCMini from Agilent.",
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/benjaminpasquiou/pyIPCMini/blob/main/CHANGELOG.md",
"Documentation": "https://pyIPCMini.readthedocs.io",
"Homepage": "https://github.com/benjaminpasquiou/pyIPCMini",
"Issues": "https://github.com/benjaminpasquiou/pyIPCMini/issues",
"Repository": "https://github.com/benjaminpasquiou/pyIPCMini.git"
},
"split_keywords": [
"ipcmini",
" driver",
" ion pump"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9adf6a00d552dc83437c9419fdaad4394f526fdd92db04876226fd9053288d10",
"md5": "5fc74f6e0bc004bfef826132ee7249d7",
"sha256": "08ce45aa89c0ed6f32f7ac3dc2061ae6e3c3a65d5cf002bfcbb9bfbf09bd1218"
},
"downloads": -1,
"filename": "pyIPCMini-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fc74f6e0bc004bfef826132ee7249d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17175,
"upload_time": "2024-07-21T12:13:29",
"upload_time_iso_8601": "2024-07-21T12:13:29.098029Z",
"url": "https://files.pythonhosted.org/packages/9a/df/6a00d552dc83437c9419fdaad4394f526fdd92db04876226fd9053288d10/pyIPCMini-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60c797b19b3485c5c54e4ddc8831d4736b46de36bb27fe65fd88e2512b4cbe63",
"md5": "f103bd275ef2a29ac0bc711dff1e73ea",
"sha256": "44a3a6402e2e7ecccc1b228ff3bde7e6b30a5d56c780ecaf583f2837ed2d976e"
},
"downloads": -1,
"filename": "pyipcmini-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f103bd275ef2a29ac0bc711dff1e73ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14251,
"upload_time": "2024-07-21T12:13:31",
"upload_time_iso_8601": "2024-07-21T12:13:31.012461Z",
"url": "https://files.pythonhosted.org/packages/60/c7/97b19b3485c5c54e4ddc8831d4736b46de36bb27fe65fd88e2512b4cbe63/pyipcmini-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-21 12:13:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "benjaminpasquiou",
"github_project": "pyIPCMini",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyipcmini"
}
