Skip to main content

COBRApy Compatible Genome Scale Metabolic Network Reconstruction Tool: Reconstructor

Project description

Reconstructor

Installation:

Install Reconstructor python package

This can be done via pip in the command line

pip install reconstructor

*You must be running >= Python 3.8

Test suite:

Use the following command to run the test suite

Run the following test to ensure reconstruction was installed correctly and is functional. This series of tests should take about an hour to run, dependent on computer/processor speed. These are runtimes for reconstructor on a 2020 MacBook Pro with a 1.4 GHz Quad-Core Intel Core i5 processor.

Use the command below to test reconstructor to ensure correct installation.

python -m reconstructor --test yes

*YOU MUST RUN THE TEST SUITE BEFORE PROCEEDING TO USE RECONSTRUCTOR

Usage:

Use reconstructor via command line

Now that reconstructor and all dependency databases are installed, you can proceed to use reconstructor via command line. An example would be:

python -m reconstructor --input <input fasta file> --type <1,2,3> --gram <negative, positive> --other arguments <args>

Type 1: Build GENRE from annotated amino acid fasta files

python -m reconstructor --input Osplanchnicus.aa.fasta --type 1 --gram negative --other_args <args>

Type 2: Build GENRE from BLASTp hits

python -m reconstructor --input Osplanchnicus.hits.out --type 2 --gram negative --other_args <args>

Type 3: Additional gap-filling (if necessary)

python -m reconstructor --input Osplanchnicus.sbml --type 3 --other_args <args>

Required and optional arguments

--input <input file, Required>
--type <input file type, .fasta = 1, diamond blastp output = 2, .sbml = 3, Required, Default = 1> 
--gram <Type of Gram classificiation (positive or negative), default = positive>
--media <List of metabolites composing the media condition. Not required.>
--tasks <List of metabolic tasks. Not required>
--org <KEGG organism code. Not required>
--min_frac <Minimum objective fraction required during gapfilling, default = 0.01>
--max_frac <Maximum objective fraction allowed during gapfilling, default = 0.5>
--out <Name of output GENRE file, default = default>
--name <ID of output GENRE, default = default>
--cpu <Number of processors to use, default = 1>
--test <run installation tests, default = no>

Additional Information

Thank you for your interest in reconstructor. If you have any additional questions please email tfz5vy@virginia.edu.

If you encounter any problems, please file an issue along with a detailed description.

Distributed under the terms of the MIT license, "reconstructor" is free and open source software

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

reconstructor-1.1.0.tar.gz (2.9 MB view hashes)

Uploaded Source

Built Distribution

reconstructor-1.1.0-py3-none-any.whl (2.9 MB 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