iqtools

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

1
contributor

Cite this software

What iqtools can do for you

Welcome to iqtools

documentationDOI

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

Quick instructions

There are many ways to install iqtools either fully or partly. One way to do a complete install is this:

TL;DR (for Linux and Mac):

Quick but full installation if you have mamba installed. Tested on Linux and Mac. First clone the repo, then go to the directory and run these commands.

mamba create -n my_env
mamba activate my_env
mamba install -y root pyqt
pip install -r requirements.txt
pip install .

Where my_env can be any name you like.

Test your installation

You can test your installation by typing:

python3 -c 'import ROOT;import PyQt5;from iqtools import*'

If the command returns without any error, then you are good, i.e. you should be able to use the library, or run one of the user interfaces.

Detailed installation instructions

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

Same goes with the installation of pyqt. If you are not interested in the GUI script, you can just ignore the installation of pyqt in the previous step. You will not be able to use the GUI, but you can still use the CLI and of course the library itself.

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 .

Windows

Under windows, ROOT / PyROOT needs to be installed in a different manner. Please refer to the installation instructions on the corresponding web page of the ROOT project. If you do not need the ROOT functions, you can still run the library, CLI and GUI under Windows. Specifically, it is recommended to download the latest version of WinPython which contains the PyQt library. Just unpacking WinPython is enough, no installation is needed. After this, you can just follow the instructions above to install the requirements and packages via pip.

Some stand alone static versions of the iqgui for windows may be made available in the future in the release section for the corresponding tags.

Quick usage

iqtools is a library that can be embedded in data analysis projects. You can use its full functionality in your own codes by importing it:

from iqtools import *

and use it accordingly.

iqtools offers user interface which do not implement the full functionality of the library, but can be useful for quick access or conversions, so it can be run as a command line program for processing data file as well. For example:

iqtools --help

The iqgui script is a graphical user interface (GUI) written in Qt with limited functionality, but nevertheless interesting features. You can run it by simply typing:

iqgui

A simple window will appear, where you can accesss some quick feartures. For more information on the GUI frontend please refer to the documentation page.

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:

Licensing

Please see the file LICENSE.md for further information about how the content is licensed.

Acknowledgements

Many thanks to @tfoerst3r for providing help with the project structure and licensing issues and to @carlkl for helping with creating a static Windows version of the GUI.

Logo of iqtools
Keywords
Programming language
  • Python 100%
License
  • CC0-1.0
  • CC-BY-4.0
  • GPL-3.0-or-later
</>Source code

Participating organisations

Helmholtz Centre for Heavy Ion Research (GSI)

Contributors

SS
Shahab Sanjari