Skip to content

SQIL core

Installation

$ pip install sqil_core

Usage

You can find all the functions available and examples in the documentation. 

import sqil_core as sqil

path = 'path to your data folder'

# Extract data in one line
mag, phase, freq = sqil.extract_h5_data(path, ['mag_dB', 'phase', 'ro_freq'])

For developers

Development

Install poetry if you haven't already (pip install poetry) and then run the following 

$ poetry install
$ poetry run pre-commit install

Test your changes

$ pip install -e . --user
If you're using a jupyter notebook remember to restart the kernel

Build

$ poetry run build

Docs

Serve docs 

$ poetry run docs_serve

Build docs 

$ poetry run docs_build