freeflux.core.metabolite
========================

.. py:module:: freeflux.core.metabolite

.. autoapi-nested-parse::

   Define the Metabolite class.



Attributes
----------

.. autoapisummary::

   freeflux.core.metabolite.__author__


Classes
-------

.. autoapisummary::

   freeflux.core.metabolite.Metabolite


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

.. py:data:: __author__
   :value: 'Chao Wu'


.. py:class:: Metabolite(id, atoms=None)

   Define Metabolite object which constitutes a Reaction.

   Metabolites are considered identical when they have the same IDs and atoms.

   :param id: Metabolite ID.
   :type id: str
   :param atoms: Carbons in metabolite, e.g., 'abcd' for metabolite without equivalents,
                 and ['abcd', 'dcba'] for metabolite with equivalents.
   :type atoms: str or list of str or None

   .. attribute:: id

      Metabolite ID.

      :type: str

   .. attribute:: atoms_info

      equivalent => coefficient, e.g., {'abcd': 1.0} or {'abcd': 0.5, 'dcba': 0.5}.

      :type: dict

   .. attribute:: n_carbons

      # of carbons in metabolite.

      :type: int

   .. attribute:: host_reactions

      Reactions hosting the metabolite.

      :type: set of Reaction or None


   .. py:attribute:: id


   .. py:attribute:: atoms
      :value: None



   .. py:attribute:: host_reactions
      :value: None



   .. py:method:: __hash__()


   .. py:method:: __eq__(other)

      :param other:
      :type other: Metabolite



   .. py:property:: atoms_info


   .. py:property:: n_carbons


   .. py:method:: __repr__()