# pyAbacus
pyAbacus is built to simplify the usage of Tausand Abacus family of coincidence counters, providing a library aimed to interface these devices using Python coding.
Written in Python3, pyAbacus relies on the following modules:
- pyserial
Library version: 1.2.1<br/>
Original release date: 12/28/2017 (mm/dd/yyyy)<br/>
Current release date: 06/11/2024<br/>
Supported models: AB1002, AB1004, AB1502, AB1504, AB2502, AB2504.
## About Tausand Abacus AB1000
This is a family of coincidence counters, ideal to measure temporal correlations in particle detection and quantum optics experiments.
To learn more about them, visit our website www.tausand.com
To obtain a Tausand's Abacus coincidence counter, visit our [online shop](http://www.tausand.com/shop) or contact us at sales@tausand.com
## Installation
`pyAbacus` can be installed using `pip` as:
```
pip install pyAbacus
```
Or from GitHub
```
pip install git+https://github.com/Tausand-dev/PyAbacus.git
```
## Examples and documentation
To learn how to use pyAbacus, take a look at the `examples` folder and run the scripts after you've installed `pyAbacus`. For more details on how to run this library, read `PyAbacus_Documentation.pdf` or navigate the HTML version located at `docs/build/html/index.html`.
## For developers
Clone the GitHub repository and then follow the next steps:
### Creating a virtual environment
Run the following code to create a virtual environment called `.venv`
```
python -m venv .venv
```
#### Activate
- On Unix systems:
```
source .venv/bin/activate
```
- On Windows:
```
.venv\Scripts\activate
```
#### Deactivate
```
deactivate
```
### Installing packages
After the virtual environment has been activated, install required packages by using:
```
python -m pip install -r requirements.txt
```
This will allow you to build the documentation using Sphinx.
### Editing version number
When a new version is created, the new numbering should be updated in the following files:
- docs/source/conf.py
- pyAbacus/\_\_init__.py
- setup.cfg
### Building docs
Go to the `docs` folder and run
```
make <command>
```
Where `<command>` is one of the following:
- `latexpdf`
- `html`
To run the `latexpdf` command you will need a working installation of Latex.
Raw data
{
"_id": null,
"home_page": "https://github.com/Tausand-dev/PyAbacus",
"name": "pyAbacus",
"maintainer": "David Guzman",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "da.guzman@outlook.com",
"keywords": null,
"author": "Juan Barbosa",
"author_email": "js.barbosa10@uniandes.edu.co",
"download_url": "https://files.pythonhosted.org/packages/c5/c7/a8b7127af9ba7d4b1cdd74ee24d98836469b3fb9dd725b84ff2d120f6bf4/pyabacus-1.2.1.tar.gz",
"platform": null,
"description": "# pyAbacus\n\npyAbacus is built to simplify the usage of Tausand Abacus family of coincidence counters, providing a library aimed to interface these devices using Python coding.\n\nWritten in Python3, pyAbacus relies on the following modules:\n- pyserial\n\nLibrary version: 1.2.1<br/>\nOriginal release date: 12/28/2017 (mm/dd/yyyy)<br/>\nCurrent release date: 06/11/2024<br/>\nSupported models: AB1002, AB1004, AB1502, AB1504, AB2502, AB2504.\n\n## About Tausand Abacus AB1000\n\nThis is a family of coincidence counters, ideal to measure temporal correlations in particle detection and quantum optics experiments.\n\nTo learn more about them, visit our website www.tausand.com\n\nTo obtain a Tausand's Abacus coincidence counter, visit our [online shop](http://www.tausand.com/shop) or contact us at sales@tausand.com\n\n## Installation\n`pyAbacus` can be installed using `pip` as: \n```\npip install pyAbacus\n```\n\nOr from GitHub\n```\npip install git+https://github.com/Tausand-dev/PyAbacus.git\n```\n\n## Examples and documentation\nTo learn how to use pyAbacus, take a look at the `examples` folder and run the scripts after you've installed `pyAbacus`. For more details on how to run this library, read `PyAbacus_Documentation.pdf` or navigate the HTML version located at `docs/build/html/index.html`.\n\n## For developers\n\nClone the GitHub repository and then follow the next steps:\n\n### Creating a virtual environment\nRun the following code to create a virtual environment called `.venv`\n```\npython -m venv .venv\n```\n\n#### Activate\n- On Unix systems:\n```\nsource .venv/bin/activate\n```\n- On Windows:\n```\n.venv\\Scripts\\activate\n```\n\n#### Deactivate\n```\ndeactivate\n```\n\n### Installing packages\nAfter the virtual environment has been activated, install required packages by using:\n```\npython -m pip install -r requirements.txt\n```\nThis will allow you to build the documentation using Sphinx.\n\n### Editing version number\nWhen a new version is created, the new numbering should be updated in the following files:\n- docs/source/conf.py\n- pyAbacus/\\_\\_init__.py \n- setup.cfg\n\n### Building docs\nGo to the `docs` folder and run\n```\nmake <command>\n```\nWhere `<command>` is one of the following:\n- `latexpdf`\n- `html`\n\nTo run the `latexpdf` command you will need a working installation of Latex.\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Built to use with Tausand Abacus coincidence counters",
"version": "1.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/Tausand-dev/PyAbacus/issues",
"Homepage": "https://github.com/Tausand-dev/PyAbacus"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "50b6b44f63dee760090462e8fcc1d480c75d5948db77bf3f3c671687f6c24112",
"md5": "ee1d72240b00fae830fe232ed687a3e9",
"sha256": "69671e2d3853f84eca06a73b3ed1e10624473bb6169f716b15f95b92f874d941"
},
"downloads": -1,
"filename": "pyAbacus-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee1d72240b00fae830fe232ed687a3e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 23879,
"upload_time": "2024-06-11T17:39:22",
"upload_time_iso_8601": "2024-06-11T17:39:22.196199Z",
"url": "https://files.pythonhosted.org/packages/50/b6/b44f63dee760090462e8fcc1d480c75d5948db77bf3f3c671687f6c24112/pyAbacus-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5c7a8b7127af9ba7d4b1cdd74ee24d98836469b3fb9dd725b84ff2d120f6bf4",
"md5": "7d26bcaa7c85ff1335e82fbcded3b334",
"sha256": "712fee837627e602476403a65585cc07e85555d6f086f4aaa809e0711099a4b7"
},
"downloads": -1,
"filename": "pyabacus-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "7d26bcaa7c85ff1335e82fbcded3b334",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 24267,
"upload_time": "2024-06-11T17:39:23",
"upload_time_iso_8601": "2024-06-11T17:39:23.875739Z",
"url": "https://files.pythonhosted.org/packages/c5/c7/a8b7127af9ba7d4b1cdd74ee24d98836469b3fb9dd725b84ff2d120f6bf4/pyabacus-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 17:39:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tausand-dev",
"github_project": "PyAbacus",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pyabacus"
}
JSON
