Formatter

Format text for printing in a readable way

_cut_to_significant_digits(number, n)

Cut a number to n significant digits.

Source code in sqil_core/utils/_formatter.py

def _cut_to_significant_digits(number, n):
    """Cut a number to n significant digits."""
    if number == 0:
        return 0  # Zero has no significant digits
    d = Decimal(str(number))
    shift = d.adjusted()  # Get the exponent of the number
    rounded = d.scaleb(-shift).quantize(
        Decimal("1e-{0}".format(n - 1)), rounding=ROUND_DOWN
    )
    return float(rounded.scaleb(shift))

_sigma_for_confidence(confidence_level)

Calculates the sigma multiplier (z-score) for a given confidence level.

Parameters:

Name	Type	Description	Default
confidence_level	float	The desired confidence level (e.g., 0.95 for 95%, 0.99 for 99%).	required

Returns:

Type	Description
float	The sigma multiplier to use for the confidence interval.

Source code in sqil_core/utils/_formatter.py

def _sigma_for_confidence(confidence_level: float) -> float:
    """
    Calculates the sigma multiplier (z-score) for a given confidence level.

    Parameters
    ----------
    confidence_level : float
        The desired confidence level (e.g., 0.95 for 95%, 0.99 for 99%).

    Returns
    -------
    float
        The sigma multiplier to use for the confidence interval.
    """
    if not (0 < confidence_level < 1):
        raise ValueError("Confidence level must be between 0 and 1 (exclusive).")

    alpha = 1 - confidence_level
    sigma_multiplier = norm.ppf(1 - alpha / 2)

    return sigma_multiplier

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']}]"