Metadata-Version: 2.4
Name: Swabian-TimeTagger
Version: 2.22.0.0
Summary: Python libraries for the Swabian Instruments Time Tagger
Author-Email: Swabian Instruments GmbH <support@swabianinstruments.com>
Project-URL: Homepage, https://www.swabianinstruments.com/time-tagger/downloads/
Requires-Python: >=3.8
Requires-Dist: numpy>=1.23.0
License-File: Third Party Licenses.txt
Description-Content-Type: text/markdown

<h1 align="center">
<img src="https://www.swabianinstruments.com/img/Swabian_Instruments_logo_RGB_line.svg" width="300">
</h1><br>

The Time Tagger series combines high performance time-to-digital converters with flexible software toolkits,
enabling you to acquire and process your digital signals on-the-fly. 

This package contains the Python libraries for the Time Tagger API and the FPGA firmware required. 
These can be used to control the hardware and to create measurements that are hooked onto the time tag stream.

- **Website:** https://www.swabianinstruments.com/
- **Downloads:** https://www.swabianinstruments.com/time-tagger/downloads/
- **Documentation:** https://www.swabianinstruments.com/static/documentation/TimeTagger/index.html
- **Installation instructions:** https://www.swabianinstruments.com/static/documentation/TimeTagger/gettingStarted/installation.html#local

## Requirements

- Python **>= 3.8**
- numpy **>= 1.25.0**
- Linux only (binary wheels for **x86_64** and **aarch64**; `manylinux_2_28` / `glibc >= 2.28`)


## Installation

```bash
python -m pip install --upgrade pip
python -m pip install Swabian-TimeTagger
```

## Usage

```python
from Swabian import TimeTagger as TT
with TT.createTimeTagger() as tagger:
    tagger.setTestSignal([1,2], True)
    with TT.Correlation(tagger=tagger, channel_1=1, channel_2=2) as corr:
        corr.startFor(1e12) # one second
        corr.waitUntilFinished()
        print(corr.getData())
```

## Support

For assistance, please reach out to us at support@swabianinstruments.com
