tfoerst3r / iqtools

Collection of code for working with offline complex valued time series data in Python.

Welcome to iqtools

Collection of code for working with offline complex valued time series data (inphase and quadrature or IQ Data) with numpy written for Python3.

Installation and usage

Preparation

If you do not need to use iqtools with ROOT features, you can skip to the next section. If you like to use iqtools with ROOT features within PyROOT, please make sure you have a proper installation of ROOT and PyROOT in your python environment. There are several alternatives of how to install ROOT:

• System wide installation on Linux (Please refer to the web site of PyROOT ). This approach is not recommended
• An easier way is to install ROOT using conda-forge as described here or here.
• Most recommended is to use mamba. For that just install mamba. Before installing, it is recommended to create a new mamba env and do your work there:

mamba create -n my_env
mamba activate my_env
mamba install root pyqt

Installing packages

Clone the repository or download the source from GitHUB. Then use pip for installing and uninstalling iqtools.

pip install -r requirements.txt
pip install .

Quick usage

iqtools is a library that can be embedded in data analysis projects. It also has a GUI and CLI for quick access or conversions, so it can be run as a command line program for processing data file as well. Type:

iqtools --help

Documentation

For more information please refer to the documentation page.

Citation for publications

If you are using this code in your publications, please refer to DOI:10.5281/zenodo.7615693 for citation, or cite as:

Shahab Sanjari. (2023). iqtools: Collection of code for working with offline complex valued time series data in Python. Zenodo. https://doi.org/10.5281/zenodo.7615693