jax_dna.energy
==============

.. py:module:: jax_dna.energy

.. autoapi-nested-parse::

   The energy model and function for jax_dna.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/jax_dna/energy/base/index
   /autoapi/jax_dna/energy/configuration/index
   /autoapi/jax_dna/energy/dna1/index
   /autoapi/jax_dna/energy/dna2/index
   /autoapi/jax_dna/energy/na1/index
   /autoapi/jax_dna/energy/potentials/index
   /autoapi/jax_dna/energy/rna2/index
   /autoapi/jax_dna/energy/utils/index


Attributes
----------

.. autoapisummary::

   jax_dna.energy.DEFAULT_DISPLACEMENT


Functions
---------

.. autoapisummary::

   jax_dna.energy.energy_fn_builder


Package Contents
----------------

.. py:data:: DEFAULT_DISPLACEMENT

.. py:function:: energy_fn_builder(energy_fns: list[base.BaseEnergyFunction], energy_configs: list[configuration.BaseConfiguration], transform_fn: collections.abc.Callable[[jax_dna.utils.types.PyTree], jax_dna.utils.types.PyTree], displacement_fn: collections.abc.Callable[[jax_dna.utils.types.PyTree], jax_dna.utils.types.PyTree] = DEFAULT_DISPLACEMENT) -> collections.abc.Callable[[jax_dna.utils.types.PyTree], float]

   Build an energy function from a list of energy functions and configurations.