mythos.utils.units
==================

.. py:module:: mythos.utils.units

.. autoapi-nested-parse::

   Units for the oxDNA model.



Attributes
----------

.. autoapisummary::

   mythos.utils.units.ANGSTROMS_PER_OXDNA_LENGTH
   mythos.utils.units.ANGSTROMS_PER_NM
   mythos.utils.units.NM_PER_OXDNA_LENGTH
   mythos.utils.units.PN_PER_OXDNA_FORCE
   mythos.utils.units.JOULES_PER_OXDNA_ENERGY


Functions
---------

.. autoapisummary::

   mythos.utils.units.get_kt
   mythos.utils.units.get_kt_from_c
   mythos.utils.units.get_kt_from_string
   mythos.utils.units.from_kt


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

.. py:data:: ANGSTROMS_PER_OXDNA_LENGTH
   :value: 8.518


.. py:data:: ANGSTROMS_PER_NM
   :value: 10


.. py:data:: NM_PER_OXDNA_LENGTH
   :value: 0.8518000000000001


.. py:data:: PN_PER_OXDNA_FORCE
   :value: 48.63


.. py:data:: JOULES_PER_OXDNA_ENERGY
   :value: 4.142e-20


.. py:function:: get_kt(t_kelvin: mythos.utils.types.ARR_OR_SCALAR) -> mythos.utils.types.ARR_OR_SCALAR

   Converts a temperature in Kelvin to kT in simulation units.


.. py:function:: get_kt_from_c(t_celsius: mythos.utils.types.ARR_OR_SCALAR) -> mythos.utils.types.ARR_OR_SCALAR

   Converts a temperature in Celsius to kT in simulation units.


.. py:function:: get_kt_from_string(temp_str: str) -> float

   Converts a temperature string (e.g. '300K', '27C') to kT in simulation units.


.. py:function:: from_kt(kt: mythos.utils.types.ARR_OR_SCALAR) -> mythos.utils.types.ARR_OR_SCALAR

   Converts kT in simulation units to temperature in Kelvin.