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

.. py:module:: dfba.variable

.. autoapi-nested-parse::

   Definition of `KineticVariable` class.



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

Classes
~~~~~~~

.. autoapisummary::

   dfba.variable.KineticVariable




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


   Bases: :py:obj:`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

   .. method:: id(self) -> str
      :property:

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


   .. method:: rhs_expression(self) -> Union[dfba.types.Expression, None]
      :property:

      Relate the rhs expression to some symbolic expression.


   .. method:: initial_condition(self) -> numbers.Number
      :property:

      Relate the ininital condition to some int or float value.