prolint.config.units
====================

.. py:module:: prolint.config.units

.. autoapi-nested-parse::

   Unit conversion and simulation parameters.

   This module provides unit conversion factors and simulation parameter
   containers for ProLint calculations.



Attributes
----------

.. autoapisummary::

   prolint.config.units.DEFAULT_SIM_PARAMS


Classes
-------

.. autoapisummary::

   prolint.config.units.UnitConversionFactor
   prolint.config.units.SimulationParams


Module Contents
---------------

.. py:class:: UnitConversionFactor(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Conversion factors from time units to seconds.

   Each member's value represents the unit in seconds.

   .. attribute:: fs

      Femtoseconds (1e-15 s).

      :type: float

   .. attribute:: ps

      Picoseconds (1e-12 s).

      :type: float

   .. attribute:: ns

      Nanoseconds (1e-9 s).

      :type: float

   .. attribute:: us

      Microseconds (1e-6 s).

      :type: float

   .. attribute:: ms

      Milliseconds (1e-3 s).

      :type: float

   .. attribute:: s

      Seconds (1.0 s).

      :type: float


   .. py:attribute:: fs
      :value: 1e-15



   .. py:attribute:: ps
      :value: 1e-12



   .. py:attribute:: ns
      :value: 1e-09



   .. py:attribute:: us
      :value: 1e-06



   .. py:attribute:: ms
      :value: 0.001



   .. py:attribute:: s
      :value: 1.0



.. py:class:: SimulationParams

   Simulation parameters for contact calculations.

   .. attribute:: units

      Time units for output (default: "us").

      :type: str

   .. attribute:: normalizer

      Normalization method (default: "actual_time").

      :type: str

   .. attribute:: unit_conversion_factor

      Factor to convert trajectory time to output units.

      :type: float

   .. attribute:: norm_factor

      Normalization factor for contact durations.

      :type: float


   .. py:attribute:: units
      :type:  str
      :value: 'us'



   .. py:attribute:: normalizer
      :type:  str
      :value: 'actual_time'



   .. py:attribute:: unit_conversion_factor
      :type:  float
      :value: 1e-06



   .. py:attribute:: norm_factor
      :type:  float
      :value: 1.0



.. py:data:: DEFAULT_SIM_PARAMS