Skip to main content

A python package to find robust perfect adaptation of chemical reaction networks.

Project description

rpa_finder

rpa_finder is a python package for the systematic discovery of Robust Perfect Adaptation (RPA) in chemical reaction networks.

The package allows for finding all the RPA properties implemented in a deterministic chemical reaction system through the enumeration of labeled buffering structures, that are in one-to-one correspondence with elementary RPA properties of the system. In other words, it facilitates the determination of the dependencies of steady-state concentrations and reaction rates on all the reaction parameters (and the values of conserved quantitites if any) in a model-independent manner.

Once we have the list of labeled buffering structures, one can, for example, do the following:

  • Finds all the concentrations and reactions affected by the change of a chosen reaction parameter.
  • Finds all the reactions that affect the steady-state value of the concentration of a chosen species.
  • Finds integral control realizing each RPA property represented by a (labeled) buffering structure.

Installation

The package can be installed via pip as

pip install rpa_finder

Usage

We here briefly describe basic usage. For more examples, see jupyter notebooks in examples directory.

Finding labeled buffering structures

First, prepare a list of reactions and create a reaction system object. For example, let us consider a reaction network with three species ${v_1,v_2,v_3}$ and the following five reactions:

  • $e_1: \emptyset \to v_1$

  • $e_2: v_1 \to v_2$

  • $e_3:v_2 \to v_3$

  • $e_4:v_3 \to v_1$

  • $e_5:v_2 \to \emptyset$

To prepare a reaction system for this network, let us first define a reaction network in a text format as

network1 = """
"", "v1"
"v1", "v2"
"v2", "v3"
"v3", "v1"
"v2", ""
"""

Note that $\emptyset$ is represented as an empty string "" in the text format.

We can create a ReactionSystem object corresponding to the network. Call the method enumerate_labeled_buffering_structures to enumerate labeled buffering structures for this network:

r_system1 = ReactionSystem(network1)

A labeled buffering structure is expressed by a quadruple, $( P, V_P, E_P, \mathcal E_P)$, where

  • $P$ denotes a set of parameters that are perturbed
  • $V_P$ denotes the set of species affected by the perturbation of the parameters in $P$
  • $E_P$ denotes the set of reactions affected by the perturbation of the parameters in $P$
  • $\mathcal E_P$ denote a set of added reactions to make the subnetwork $(V_P,E_P \cup \mathcal E_P)$ output-complete

Labeled buffering structures for a given reaction system can be found by the following function,

lbs_list = r_system1.enumerate_labeled_buffering_structures()

The output is

[
    [[0], [0, 1, 2], [0, 1, 2, 3, 4], []],
    [[1], [0], [], [1]],
    [[2], [0, 2], [1, 2, 3], []],
    [[3], [2], [], [3]],
    [[4], [0, 1, 2], [1, 2, 3], [4]]
]

The species and reactions are indicated by indices. Note that, unlike the Mathematica version, indicees start with zero. To use names for species, one can use lbs_to_name:

lbs_name = [ r_system1.lbs_to_name(l) for l in lbs_list]

The content of lbs_name is

[
    [[0], ['v1', 'v2', 'v3'], [0, 1, 2, 3, 4], []],
    [[1], ['v1'], [], [1]],
    [[2], ['v1', 'v3'], [1, 2, 3], []],
    [[3], ['v3'], [], [3]],
    [[4], ['v1', 'v2', 'v3'], [1, 2, 3], [4]]
]

We can read off the dependencies of concentrations and reaction rates on all the system parameters. For example, from the third labeled buffering structure, we can see that the perturbation of the parameter of reaction $e_3$ (recall that the index of reactions in the code starts with zero, while the index in the original reaction list starts with one) affects the concentrations of $v_1$ and $v_3$ and the rates of reactions $e_2,e_3,e_4$. It does not affect the concentration of $v_2$ and reaction rates of $e_1$ and $e_5$, which means that they exhibit RPA with respect to this parameter.

Finding integral control

For every labeled buffering structure, one can find integral control realizing the RPA property. For example, let us find integrator equations for lbs_list[1]:

integrators = r_system1.find_integrators_from_lbs(
    lbs_list[1], symbol_mode='name'
    )

for i in range(4):
    display( 
        Markdown(
            "$\\frac{d}{dt}" + integrators[2*i] 
            + "=" 
            + integrators[2*i+1] + "$"
            ) 
        )

The output is

$$\frac{d}{dt}\left[\begin{matrix}\end{matrix}\right]=\left[\begin{matrix}\end{matrix}\right]$$

$$\frac{d}{dt}\left[\begin{matrix}v_{1} + v_{2}\v_{3}\end{matrix}\right]=\left[\begin{matrix}r_{1} - r_{3} + r_{4} - r_{5}\r_{3} - r_{4}\end{matrix}\right]$$

$$\frac{d}{dt}\left[\begin{matrix}- v_{1}\end{matrix}\right]=\left[\begin{matrix}- r_{1} + r_{2} - r_{4}\end{matrix}\right]$$

$$\frac{d}{dt}\left[\begin{matrix}v_{2}\end{matrix}\right]=\left[\begin{matrix}r_{2} - r_{3} - r_{5}\end{matrix}\right]$$

In general, there are four sets of equations constituting integrators.

Note that the indices specifying the parameters is arranged in the order of $(\vec k, \vec \ell)$, where $\vec k$ are rate parameters and $\vec \ell$ are the values of conserved quantities. As a basis of conserved quantities, those return by scipy.linalg.null_space(s) is used, where s is the stoichiometric matrix of the reaction system.

Testing

Tests can be run by python -m unittest discover -s tests

Reference

  • Y. Hirono, A. Gupta, M. Khammash, "Complete characterization of robust perfect adaptation in biochemical reaction networks," arXiv:2307.07444.

Contact

If you have any questions or suggestions, feel free to drop an email to Yuji Hirono.

License

RPAFinder is licensed under the MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rpa_finder-0.1.0.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rpa_finder-0.1.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file rpa_finder-0.1.0.tar.gz.

File metadata

  • Download URL: rpa_finder-0.1.0.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.6

File hashes

Hashes for rpa_finder-0.1.0.tar.gz
Algorithm Hash digest
SHA256 70ffe82a2151386d8dc8b9c2920134ffb134bac3852a35c03a795b1f1021aefa
MD5 e643d79607094aa89cf4b6d2443fc542
BLAKE2b-256 9a55d1b431eccce6ab8314aec72c69123b9ad637de0d35d772c3f1d083e10675

See more details on using hashes here.

File details

Details for the file rpa_finder-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rpa_finder-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.6

File hashes

Hashes for rpa_finder-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 644aa50f9d03145c3e7e581ea8d1bdd38e02c8f1d9d86f0b6e3d349fdc2de466
MD5 7000f25da57fe4fabff91987ed329400
BLAKE2b-256 d284fd54a157e6e10151b90facb333833cbd03e930acb77ab4d9564923315bfa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page