library and examples to use Tausand Tempico TP1000 devices with Python
Written in Python3, pyTempico relies on the following modules:
- pyserial
Library version: 1.0.0
Original release date: 02/12/2024 (mm/dd/yyyy)
Current release date: 02/12/2024
Supported models: TP1004.
This is a family of time-to-digital converters, ideal to measure time differences between electrical pulses in particle detection, microscopy, and quantum optics experiments.
To learn more about them, visit our website www.tausand.com
To obtain a Tausand's Tempico time-to-digital converter, visit our online shop or contact us at [email protected]
pyTempico
can be installed using pip
as:
pip install pyTempico
Or from GitHub
pip install git+https://github.com/Tausand-dev/PyTempico.git
For details on how to run this library, read the PDF documentation located at docs/build/latex/pytempico.pdf
, or navigate the HTML version located at docs/build/html/index.html
.
Clone the GitHub repository and then follow the next steps:
Run the following code to create a virtual environment called .venv
python -m venv .venv
- On Unix systems:
source .venv/bin/activate
- On Windows:
.venv\Scripts\activate
deactivate
After the virtual environment has been activated, install required packages by using:
python -m pip install -r requirements.txt
When a new version is created, the new numbering should be updated in the following files:
- pyTempico/__init__.py
- README.md
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.
After the virtual environment has been activated, and the packages has been installed, run the command
python -m build
Once completed, this should generate two files in the \dist
directory: a .tar.gz
and a .whl
file. These files may be published in the TestPyPI or the PyPI repositories.