Documentation for STLabutils¶
Contents:
- S11fit – Resonance fitting routines and utilities
- TLmodel – Model for transmission line resonator
- Autoplot – Quick plots for measurement reference
- Metagen – Spyview metafile generation
- newfile – New measurement folder creation
- stlabdict – Data structures and matrices
- writematrix – Data file writing methods
- Example for S11fit
- Example for autoplot
- Example for readdata
Introduction¶
STLabutils is a collection of tool scripts used for file creation, reading and equipment control and analysis.
It is used together with STLab for measurements performed in the SteeleLab at TU Delft.
While STLab is necessary for performing measurements and communication with instruments, STLabutils is a standalone
library which can be used by itself to read and analyse datafiles, and perform certain simulations.
STLabutils were formerly contained within stlab.utils.
The basic structure of the package is as follows:
The “utils” folder contains modules for reading and writing files, resonance fitting, data structure management (stlabmtx for example). These packages were formely contained within
stlab.utils.“examples” contains a collection of basic examples such as loading and plotting example data and Q factor fits.
“docs” contains this documentation and “doc_gen” contains the sphynx scripts for generating it.
The __init__.py file contains the modules and names imported when running “import stlabutils”. Note that some modules and functions are renamed for (in?)convenience.
The imports done when doing import stlabutils are:
name = 'stlabutils'
# __all__ = ["metagen", "readdata", "S11fit", "newfile"]
# Loads utils with shorter names
# from stlabutils.X.Y import Z becomes stlabutils.Z
# File creation, callable as stlabutils.newfile(...)
from .newfile import *
# Metagen creation, callable as stlabutils.metagen.fromlimits(...)
from .metagen import *
# File reading, callable as stlabutils.readdata.readQUCS(...)
from .readdata import *
# File writing, callable as stlabutils.savetxt(...)
from .writematrix import *
from .stlabdict import *
# Fitting routines, callable as stlabutils.S11fit(...)
from .S11fit import *
# Autoplotter, callable as stlabutils.autoplot(...)
from .autoplotter import *
# git id, callable as stlabutils.get_gitid(...)
from .getgitid import *
Indices and tables¶
License¶
stlabutils is licensed under the GNU General Public License v3.0.