an_tdc_errors

In this repository are the sources from which the application note available at docs.cronologic.de/app_notes/tdc_errors.

The application note discusses the difference between quantization errors and jitter of time-to-digital converters (TDCs), such as the xHPTDC8, xTDC4, and TimeTagger devices sold by cronologic.

Building the application note

Prerequisites

Python is necessary for creating the HTML output.

Optionally, create and activate a virtual environment

python -m venv .venv
. .\.venv\Scripts\activate

Depending on your operating system, you may need to run a different activation script.

The requirements are listed in requirements.txt, requirements-frozen.txt, and requirements-dev.txt.

If you want to guarantee the output to be the same as hosted at docs.cronologic.de, install the packages listed in requirements-frozen.txt, that is, run

pip install -r requirements-frozen.txt

If you want to install the most up-to-date versions of the prerequisites, use requirements.txt.

If you want to install the most up-to-date versions and also install plotting libraries (e.g., to run Python scripts in source/_code/), use requirements-dev.txt.

Building

Run

cd app_note
make html

to compile the project as HTML. The HTML output is in build/html/.

License

This documentation is licensed under the CC BY-ND 4.0 license. You are free to copy and redistribute the material in any medium or format for any purpose, even commercially unchanged if you give appropriate credit to cronologic GmbH & Co. KG. A link to this repository or the application note is sufficient. If you decide to contribute to this repository, you transfer non-exclusive but unlimited rights to your edit to cronologic GmbH & Co. KG.