Skip to content

Commit 2f16a49

Browse files
authored
v1.2.0
Included support for new AB2000 family devices: AB2502 and AB2504. Corrections made in open function.
2 parents 2b27c72 + 6320427 commit 2f16a49

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+20064
-52
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,3 +227,4 @@ dmypy.json
227227

228228
# End of https://www.toptal.com/developers/gitignore/api/python,pycharm+all
229229

230+
log_pyabacus.txt

PyAbacus_Documentation.pdf

3.94 KB
Binary file not shown.

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
# pyAbacus
22

3-
pyAbacus was built to simplify the usage of Tausand Abacus family of coincidence counters, providing a library aimed to interface these devices using Python coding.
3+
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.
44

55
Written in Python3, pyAbacus relies on the following modules:
66
- pyserial
77

8+
Library version: 1.2.0<br/>
9+
Original release date: 12/28/2017 (mm/dd/yyyy)<br/>
10+
Current release date: 01/12/2023<br/>
11+
Supported models: AB1002, AB1004, AB1502, AB1504, AB2502, AB2504.
12+
13+
## About Tausand Abacus AB1000
14+
15+
This is a family of coincidence counters, ideal to measure temporal correlations in particle detection and quantum optics experiments.
16+
17+
To learn more about them, visit our website www.tausand.com
18+
19+
To obtain a Tausand's Abacus coincidence counter, visit our [online shop](http://www.tausand.com/shop) or contact us at sales@tausand.com
820

921
## Installation
1022
`pyAbacus` can be installed using `pip` as:
@@ -52,6 +64,12 @@ python -m pip install -r requirements.txt
5264
```
5365
This will allow you to build the documentation using Sphinx.
5466

67+
### Editing version number
68+
When a new version is created, the new numbering should be updated in the following files:
69+
- docs/source/conf.py
70+
- pyAbacus/\_\_init__.py
71+
- setup.cfg
72+
5573
### Building docs
5674
Go to the `docs` folder and run
5775
```

docs/build/html/_images/logo.png

13.9 KB
Loading
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pyAbacus.constants
2+
=========================================
3+
4+
.. automodule:: pyAbacus.constants
5+
:members:
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pyAbacus.core
2+
=========================================
3+
4+
.. automodule:: pyAbacus.core
5+
:members:
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pyAbacus.exceptions
2+
=========================================
3+
4+
.. automodule:: pyAbacus.exceptions
5+
:members:
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. PyAbacus documentation master file, created by
2+
sphinx-quickstart on Fri Sep 24 18:47:47 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
.. figure:: logo.png
7+
:scale: 15 %
8+
:alt: Tausand logo
9+
:align: center
10+
11+
Welcome to PyAbacus's documentation!
12+
====================================
13+
14+
pyAbacus was built to simplify the usage of Tausand_ Abacus family of coincidence counters, providing a library aimed to interface these devices using Python coding.
15+
16+
.. _Tausand: https://www.tausand.com/
17+
18+
19+
Contents
20+
-----------------------------------------
21+
.. toctree::
22+
:maxdepth: 2
23+
24+
core
25+
26+
.. toctree::
27+
:maxdepth: 2
28+
29+
exceptions
30+
31+
.. toctree::
32+
:maxdepth: 2
33+
34+
constants
35+
36+
37+
Indices and tables
38+
==================
39+
40+
* :ref:`genindex`
41+
* :ref:`modindex`
42+
* :ref:`search`

0 commit comments

Comments
 (0)