Skip to main content

'pathway completion'

Project description


Anaconda-Server Badge Anaconda-Server Badge

Completes mono-component reactions output by RetroPath2.0 with the appropriate cofactors. Creates sub-paths when multiple reaction rules are associated with a single reaction. Input is a single pathways file produced by RP2Paths. It stands on rpCache which store pre-computed data.



  • rp2_pathways: (string) Path to the RetroPath2.0 pathways file
  • rp2paths_compounds: (string) Path to the rp2paths compounds file
  • rp2paths_pathways: (string) Path to the rp2paths pathways file
  • outdir: (string) Path to the folder where result files are written

Advanced options:

  • -upper_flux_bound: (integer, default=9999) Upper flux bound value
  • -lower_flux_bound: (integer, default=0) Lower flux bound value
  • -maxSubPaths_filter: (integer, default=10) Number of subpaths per path
  • -pathway_id: (string, default=rp_pathway) ID of the heterologous pathway
  • -compartment_id: (string, default=MNXC3 (i.e. cytoplasm)) Heterologous pathway compartment ID
  • -species_group_id: (string, default=central_species) ID of the central species, i.e. not cofactors, in the heterologous reactions
  • --store-mode, -sm: (optional, string, default: file) Store mode. If 'file', rpCache is supposed to be stored in files. Else, the rpCache is supposed to be stored in a redis database which the name is the value of this input field. The redis server is considered to be up and running.

Memory management

File mode

This is the default mode. All cache data are stored into files on disk and loaded in memory each time the tool is used. In this mode, fingerprint in memory is equal to the size of cache files loaded in memory multiplied by the number of processes which are running at the same time. Option can be specified by --store-mode file.

DB mode

In order to save memory space, cache data can be loaded once in a database (redis) so that the memory space taken is equal to one instance of the cache, whatever the number of processes whic are running. Option can be specified by --store-mode <db_host>, where db_host is the hostname on which redis server is running.


rpCompletion requires RDKit which is not available through pip. It can be installed through Conda:

[sudo] conda install -c rdkit rdkit

From pip

[sudo] python -m pip install rpcompletion

From Conda

[sudo] conda install -c brsynth rpcompletion


rpCompletion process

From Python code

from rpcompletion import rpCompletion, build_args_parser

parser = build_args_parser()
args  = parser.parse_args()

rpcompletion = rpCompletion(db=args.store_mode)

From CLI

python -m rpcompletion \
  rp2_pathways.csv \
  rp2paths_compounds.csv \
  rp2paths_pathways.csv \


Tests can be runned. To do so, please follow insructions below:

cd tests


  • Melchior du Lac
  • Joan Hérisson


  • Thomas Duigou


rpCompletion is released under the MIT licence. See the LICENCE file 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

rpcompletion-1.2.0.tar.gz (17.9 kB view hashes)

Uploaded Source

Built Distribution

rpcompletion-1.2.0-py3-none-any.whl (19.0 kB view hashes)

Uploaded Python 3

Supported by

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