.. _utils:

******************************
The `simulators.utils` library
******************************

.. only:: html

   .. topic:: Abstract

      This part of the documentation describes all useful functions that were
      implemented in the `utils` library in order to speed up the development
      of new simulator modules.

.. only:: latex

   This part of the documentation describes all useful functions that were
   implemented in the `utils` library in order to speed up the development of
   new simulator modules.


The Utils library
=================

.. module:: simulators.utils

.. autofunction:: checksum

.. autofunction:: binary_complement

.. autofunction:: twos_to_int

.. autofunction:: int_to_twos

.. autofunction:: binary_to_bytes

.. autofunction:: bytes_to_int

.. autofunction:: bytes_to_binary

.. autofunction:: bytes_to_uint

.. autofunction:: real_to_binary

.. autofunction:: real_to_bytes

.. autofunction:: bytes_to_real

.. autofunction:: int_to_bytes

.. autofunction:: uint_to_bytes

.. autofunction:: sign

.. autofunction:: mjd

.. autofunction:: mjd_to_date

.. autofunction:: day_microseconds

.. autofunction:: day_milliseconds

.. autofunction:: day_percentage

.. _get_multitype_systems:
.. autofunction:: get_multitype_systems

.. autofunction:: list_simulators