etfba.core.metabolite
=====================

.. py:module:: etfba.core.metabolite

.. autoapi-nested-parse::

   Difine the Metabolite class.



Classes
-------

.. autoapisummary::

   etfba.core.metabolite.Singleton
   etfba.core.metabolite.Metabolite


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

.. py:class:: Singleton(name, bases, attrs)

   Bases: :py:obj:`type`


   Make a singleton metaclass.


   .. py:attribute:: _instances


   .. py:method:: __call__(*args, **kwargs)

      Call self as a function.



.. py:class:: Metabolite(metabid, name=None, compartment=None, *, is_h=False, is_h2o=False)

   Metabolite instances created with identical IDs, names, and all other attributes
   are treated as a singular instance.

   .. attribute:: kms

      Key is the reaction ID where the metabolite is involved, value is the
      corresponding Km value.

      :type: PrettyDict

   .. attribute:: km

      Km value of the metabolite in the host reaction.

      :type: positive float

   .. attribute:: coes

      Key is the reaction ID where the metabolite is involved, value is the
      corresponding stoichiometric coefficient in the reaction. Negative for
      substrates and positive for products.

      :type: PrettyDict

   .. attribute:: coe

      Stoichiometric coefficient of the metabolite in the host reaction.

      :type: positive float

   .. attribute:: is_h

      Indicates whether it is a proton.

      :type: bool

   .. attribute:: is_h2o

      Indicates whether it is water.

      :type: bool

   .. attribute:: is_constrained_by_mass_balance

      Indicates whether it appears in the mass balance constraints.

      :type: bool

   .. attribute:: host

      The host reaction of the metabolite.

      :type: Reaction

   .. attribute:: role

      Role played by the metabolite in the host reaction.

      :type: {'substrate', 'product'}


   .. py:attribute:: metabid


   .. py:attribute:: name


   .. py:attribute:: compartment


   .. py:attribute:: is_h


   .. py:attribute:: is_h2o


   .. py:attribute:: kms


   .. py:attribute:: coes


   .. py:attribute:: is_constrained_by_mass_balance
      :value: False



   .. py:attribute:: host
      :value: None



   .. py:attribute:: role
      :value: None



   .. py:property:: km


   .. py:property:: coe


   .. py:method:: __repr__()

      Return repr(self).