Common utilities
================

The :doc:`tool-module migration guide <../en/framework/tool-modules>` maps
imports from the historical :mod:`mpylab.tools.util` facade to the focused
modules used by new applications. The :doc:`complete generated reference
<full-reference>` contains utilities that are intentionally omitted from this
curated selection.

Unit conversion
---------------

:mod:`mpylab.tools.uconv` is the canonical conversion backend. Keep SCUQ
quantities in measurement and evaluation code; convert at protocol and
presentation boundaries.

.. autoclass:: mpylab.tools.uconv.UConv
   :members:

.. autofunction:: mpylab.tools.uconv.to_quantity

.. autofunction:: mpylab.tools.uconv.from_quantity

.. autofunction:: mpylab.tools.uconv.to_scuq_value_unit

.. autofunction:: mpylab.tools.uconv.value_from_unit_to_unit

.. autofunction:: mpylab.tools.uconv.scuq_value_unit_to_unit

.. autofunction:: mpylab.tools.uconv.quantity_to_db

.. autofunction:: mpylab.tools.uconv.quantity_to_dBm

.. autoclass:: mpylab.tools.uconv.AsymmetricDBValue
   :members:

S-parameter representation
--------------------------

The phase unit is explicit in each function name.

.. autofunction:: mpylab.tools.uconv.sparam_complex_to_db_phase_rad

.. autofunction:: mpylab.tools.uconv.sparam_complex_to_db_phase_deg

.. autofunction:: mpylab.tools.uconv.sparam_db_phase_rad_to_complex

.. autofunction:: mpylab.tools.uconv.sparam_db_phase_deg_to_complex

Generated file names
--------------------

.. autofunction:: mpylab.tools.filenames.filename_token

.. autofunction:: mpylab.tools.filenames.format_output_filename

Script configuration
--------------------

.. autoclass:: mpylab.env.script_cli.ConfigError

.. autofunction:: mpylab.env.script_cli.update_conf

.. autofunction:: mpylab.env.script_cli.resolve_autosave_resume