jax_dna.energy.dna2.nucleotide
==============================

.. py:module:: jax_dna.energy.dna2.nucleotide

.. autoapi-nested-parse::

   Extends `jax_md.rigid_body.RigidBody` for DNA2 nucleotide.



Classes
-------

.. autoapisummary::

   jax_dna.energy.dna2.nucleotide.Nucleotide


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

.. py:class:: Nucleotide

   Bases: :py:obj:`jax_dna.energy.base.BaseNucleotide`


   Nucleotide rigid body with additional sites for DNA2.

   This class is inteneded to be used as a dataclass for a nucleotide rigid body
   as a `rigid_body_transform_fn` in `jax_md.energy.ComposedEnergyFunction`.


   .. py:attribute:: center
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: orientation
      :type:  jax_dna.utils.types.Arr_Nucleotide_3 | jax_md.rigid_body.Quaternion


   .. py:attribute:: stack_sites
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: back_sites
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: back_sites_dna1
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: base_sites
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: back_base_vectors
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: base_normals
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:attribute:: cross_prods
      :type:  jax_dna.utils.types.Arr_Nucleotide_3


   .. py:method:: from_rigid_body(rigid_body: jax_md.rigid_body.RigidBody, com_to_backbone_x: jax_dna.utils.types.Scalar, com_to_backbone_y: jax_dna.utils.types.Scalar, com_to_backbone_dna1: jax_dna.utils.types.Scalar, com_to_hb: jax_dna.utils.types.Scalar, com_to_stacking: jax_dna.utils.types.Scalar) -> Nucleotide
      :staticmethod:


      Class method to precompute nucleotide sites from a rigid body.