:mod:`dfba.variable`
====================

.. py:module:: dfba.variable

.. autoapi-nested-parse::

   Definition of `KineticVariable` class.



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

Classes
~~~~~~~

.. autoapisummary::

   dfba.variable.KineticVariable



.. py:class:: KineticVariable(name: str, initial_condition: Number = 0.0, *args, **kwargs)

   Bases: :class:`optlang.symbolics.Symbol`

   Class for holding information for a kinetic variable in a `DfbaModel` object.

   .. attribute:: id

      The identifier to associate with this kinetic variable.

      :type: string

   .. attribute:: rhs_expression

      The symbolic expression for calculating derivative of this kinetic
      variable wrt time.

      :type: optlang.symbolics expression

   .. attribute:: initital_condition

      The initial value of this kinetic variable to be used at start of
      simulation.

      :type: int or float

   .. attribute:: id
      :annotation: :str

      For convenience, synonym with .name from `symbolics.Symbol`.


   .. attribute:: rhs_expression
      :annotation: :Union[Expression, None]

      Relate the rhs expression to some symbolic expression.


   .. attribute:: initial_condition
      :annotation: :Number

      Relate the ininital condition to some int or float value.