From 949bf649a2a01f9905b280e28c0aa953048e440f Mon Sep 17 00:00:00 2001 From: <> Date: Fri, 20 Dec 2024 14:58:55 +0000 Subject: [PATCH] Deployed e142512 with MkDocs version: 1.6.1 --- .nojekyll | 0 404.html | 468 ++ API reference/utils/Analysis/index.html | 845 +++ API reference/utils/Formatter/index.html | 949 +++ API reference/utils/Read data/index.html | 1165 +++ assets/_mkdocstrings.css | 143 + assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.88dd0f4e.min.js | 16 + assets/javascripts/bundle.88dd0f4e.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.6ce7567c.min.js | 42 + .../workers/search.6ce7567c.min.js.map | 7 + assets/stylesheets/main.6f8fc17f.min.css | 1 + assets/stylesheets/main.6f8fc17f.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + index.html | 609 ++ objects.inv | Bin 0 -> 533 bytes search/search_index.json | 1 + sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes 54 files changed, 11460 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 API reference/utils/Analysis/index.html create mode 100644 API reference/utils/Formatter/index.html create mode 100644 API reference/utils/Read data/index.html create mode 100644 assets/_mkdocstrings.css create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.88dd0f4e.min.js create mode 100644 assets/javascripts/bundle.88dd0f4e.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.6ce7567c.min.js create mode 100644 assets/javascripts/workers/search.6ce7567c.min.js.map create mode 100644 assets/stylesheets/main.6f8fc17f.min.css create mode 100644 assets/stylesheets/main.6f8fc17f.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 index.html create mode 100644 objects.inv create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..11b827c --- /dev/null +++ b/404.html @@ -0,0 +1,468 @@ + + + +
+ + + + + + + + + + + + + + +estimate_linear_background(x, data, points_cut=0.1)
+
+Estimates a linear background hihi
+ +sqil_core/utils/analysis.py
remove_linear_background(x, data, points_cut=0.1)
+
+Removes a linear background from the input data (e.g. the phase background +of a spectroscopy).
+data : np.ndarray + Input data. Can be a 1D vector or a 2D matrix.
+np.ndarray
+ The input data with the linear background removed. The shape of the
+ returned array matches the input data
.
sqil_core/utils/analysis.py
remove_offset(data, avg=3)
+
+Removes the initial offset from a data matrix or vector by subtracting
+the average of the first avg
points. After applying this function,
+the first point of each column of the data will be shifted to (about) 0.
data : np.ndarray + Input data, either a 1D vector or a 2D matrix +avg : int, optional + The number of initial points to average when calculating + the offset, by default 3
+np.ndarray + The input data with the offset removed
+ +sqil_core/utils/analysis.py
Format text for printing in a readable way
+ + +build_title(title, path, params)
+
+Build a plot title that includes the values of given parameters found in +the params_dict.json file, e.g. One tone with I = 0.5 mA.
+title : str + Title of the plot to which the parameters will be appended.
+ + +Path to the param_dict.json file.
+List of keys of parameters in the param_dict.json file.
+str + The original title followed by parameter values.
+ +sqil_core/utils/formatter.py
format_number(num, precision=3, unit='', latex=True)
+
+Format a number (or an array of numbers) in a nice way for printing.
+num : float | np.ndarray + Input number (or array). Should not be rescaled, + e.g. input values in Hz, NOT GHz +precision : int + The number of digits of the output number. Must be >= 3. +unit : str, optional + Unit of measurement, by default '' +latex : bool, optional + Include Latex syntax, by default True
+str + Formatted number
+ +sqil_core/utils/formatter.py
get_name_and_unit(param_id)
+
+Get the name and unit of measurement of a prameter, e.g. Frequency [GHz].
+param : str + Parameter ID, as defined in the param_dict.json file.
+str + Name and [unit]
+ +sqil_core/utils/formatter.py
ParamInfo
+
+
+Parameter information for items of param_dict
+ + +Attributes:
+Name | +Type | +Description | +
---|---|---|
id |
+
+ str
+ |
+
+
+
+ param_dict key + |
+
value |
+
+ any
+ |
+
+
+
+ the value of the parameter + |
+
name |
+
+ str
+ |
+
+
+
+ full name of the parameter (e.g. Readout frequency) + |
+
symbol |
+
+ str
+ |
+
+
+
+ symbol of the parameter in Latex notation (e.g. f_{RO}) + |
+
unit |
+
+ str
+ |
+
+
+
+ base unit of measurement (e.g. Hz) + |
+
scale |
+
+ int
+ |
+
+
+
+ the scale that should be generally applied to raw data (e.g. 1e-9 to take raw Hz to GHz) + |
+
sqil_core/utils/read.py
__str__()
+
+to_dict()
+
+Convert ParamInfo to a dictionary.
+ +sqil_core/utils/read.py
extract_h5_data(path, keys=None)
+
+Extract data at the given keys from an HDF5 file. If no keys are +given (None) returns the data field of the object.
+path : str + path to the HDF5 file or a folder in which is contained a data.ddh5 file +keys : None or List, optional + list of keys to extract from file['data'], by default None
+Dict or Tuple[np.ndarray, ...] + The full data dictionary if keys = None. + The tuple with the requested keys otherwise.
+Extract the data object from the dataset:
+>>> data = extract_h5_data(path)
+Extracting only 'amp' and 'phase' from the dataset:
+>>> amp, phase = extract_h5_data(path, ['amp', 'phase'])
+Extracting only 'phase':
+>>> phase, = extract_h5_data(path, ['phase'])
+
sqil_core/utils/read.py
read_json(path)
+
+Reads a json file and returns the data as a dictionary.
+ + +read_param_dict(path)
+
+Read param_dict and include additional information for each entry.
+path : str + Path to the file or a folder in which is contained a param_dict.json file
+ParamDict + The param_dict with additional metadata
+ +sqil_core/utils/read.py