Formatter

Format text for printing in a readable way

ParamInfo

Parameter information for items of param_dict

Attributes: id (str): QPU 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)

Source code in sqil_core/utils/_formatter.py

class ParamInfo:
    """Parameter information for items of param_dict

    Attributes:
        id (str): QPU 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)
    """

    def __init__(self, id, value=None, metadata=None):
        self.id = id
        self.value = value

        if metadata is not None:
            meta = metadata
        elif id in PARAM_METADATA:
            meta = PARAM_METADATA[id]
        else:
            meta = {}

        self.name = meta.get("name", None)
        self.symbol = meta.get("symbol", id)
        self.unit = meta.get("unit", "")
        self.scale = meta.get("scale", 1)
        self.precision = meta.get("precision", 3)

        if self.name is None:
            self.name = self.id[0].upper() + self.id[1:].replace("_", " ")

    def to_dict(self):
        """Convert ParamInfo to a dictionary."""
        return {
            "id": self.id,
            "value": self.value,
            "name": self.name,
            "symbol": self.symbol,
            "unit": self.unit,
            "scale": self.scale,
            "precision": self.precision,
        }

    @property
    def name_and_unit(self, latex=True):
        unit = f"[{self.rescaled_unit}]" if self.unit or self.scale != 1 else ""
        if unit == "":
            return unit
        return self.name + rf" ${unit}$" if latex else rf" {unit}"

    @property
    def rescaled_unit(self):
        # if self.unit == "":
        #     return self.unit
        exponent = -(int(f"{self.scale:.0e}".split("e")[1]) // 3) * 3
        unit = f"{_EXP_UNIT_MAP[exponent]}{self.unit}"
        return unit

    @property
    def symbol_and_value(self, latex=True):
        sym = f"${self.symbol}$" if latex else self.symbol
        equal = f"$=$" if latex else " = "
        val = format_number(self.value, self.precision, self.unit, latex=latex)
        return f"{sym}{equal}{val}"

    def __str__(self):
        """Return a JSON-formatted string of the object."""
        return json.dumps(self.to_dict())

    def __eq__(self, other):
        if isinstance(other, ParamInfo):
            return (self.id == other.id) & (self.value == other.value)
        if isinstance(other, (int, float, complex, str)):
            return self.value == other
        return False

    def __bool__(self):
        return bool(self.id)

__str__()

Return a JSON-formatted string of the object.

Source code in sqil_core/utils/_formatter.py

def __str__(self):
    """Return a JSON-formatted string of the object."""
    return json.dumps(self.to_dict())

to_dict()

Convert ParamInfo to a dictionary.

Source code in sqil_core/utils/_formatter.py

def to_dict(self):
    """Convert ParamInfo to a dictionary."""
    return {
        "id": self.id,
        "value": self.value,
        "name": self.name,
        "symbol": self.symbol,
        "unit": self.unit,
        "scale": self.scale,
        "precision": self.precision,
    }

format_number(num, precision=3, unit='', latex=True)

Format a number (or an array of numbers) in a nice way for printing.

Parameters:

Name	Type	Description	Default
num	float | ndarray	Input number (or array). Should not be rescaled, e.g. input values in Hz, NOT GHz	required
precision	int	The number of digits of the output number. Must be >= 3.	3
unit	str	Unit of measurement, by default ''	''
latex	bool	Include Latex syntax, by default True	True

Returns:

Type	Description
str	Formatted number

Source code in sqil_core/utils/_formatter.py

def format_number(
    num: float | np.ndarray, precision: int = 3, unit: str = "", latex: bool = True
) -> str:
    """Format a number (or an array of numbers) in a nice way for printing.

    Parameters
    ----------
    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

    Returns
    -------
    str
        Formatted number
    """
    # Handle arrays
    if isinstance(num, (list, np.ndarray)):
        return [format_number(n, precision, unit, latex) for n in num]

    # Return if not a number
    if not isinstance(num, (int, float, complex)):
        return num

    # Format number
    exp_form = f"{num:.12e}"
    base, exponent = exp_form.split("e")
    # Make exponent a multiple of 3
    base = float(base) * 10 ** (int(exponent) % 3)
    exponent = (int(exponent) // 3) * 3
    # Apply precision to the base
    if precision < 3:
        precision = 3
    base_precise = _cut_to_significant_digits(
        base, precision + 1
    )  # np.round(base, precision - (int(exponent) % 3))
    base_precise = np.round(
        base_precise, precision - len(str(base_precise).split(".")[0])
    )
    if int(base_precise) == float(base_precise):
        base_precise = int(base_precise)

    # Build string
    if unit:
        res = f"{base_precise}{'~' if latex else ' '}{_EXP_UNIT_MAP[exponent]}{unit}"
    else:
        res = f"{base_precise}" + (f" x 10^{{{exponent}}}" if exponent != 0 else "")
    return f"${res}$" if latex else res

get_name_and_unit(param_id)

Get the name and unit of measurement of a prameter, e.g. Frequency [GHz].

Parameters:

Name	Type	Description	Default
param	str	Parameter ID, as defined in the param_dict.json file.	required

Returns:

Type	Description
str	Name and [unit]

Source code in sqil_core/utils/_formatter.py

def get_name_and_unit(param_id: str) -> str:
    """Get the name and unit of measurement of a prameter, e.g. Frequency [GHz].

    Parameters
    ----------
    param : str
        Parameter ID, as defined in the param_dict.json file.

    Returns
    -------
    str
        Name and [unit]
    """
    meta = PARAM_METADATA[param_id]
    scale = meta["scale"] if "scale" in meta else 1
    exponent = -(int(f"{scale:.0e}".split("e")[1]) // 3) * 3
    return f"{meta['name']} [{_EXP_UNIT_MAP[exponent]}{meta['unit']}]"