Skip to main content

A Python package for metabolic modeling

Project description

CarveMeGut

CarveMeGut is a Python package designed for metabolic model reconstruction and curation, particularly tailored for gut microbiome studies. It automates the process of extracting, curating, and refining genome-scale metabolic models using various datasets and computational methods.

Features

  • Automated metabolic model reconstruction from genome sequences
  • Integration with public metabolic databases
  • Gap-filling for incomplete metabolic networks
  • Support for various file formats (FASTA, SBML, etc.)
  • CLI tools for streamlined workflows

Installation

CarveMeGut requires Python 3.7 or higher. Install it using pip:

pip install carvemegut

Alternatively, you can install the latest development version from GitHub:

git clone https://github.com/yourusername/carvemegut.git
cd carvemegut
pip install .

Usage

CLI Usage

CarveMeGut provides a command-line interface (CLI) for ease of use. After installation, you can use:

carvemegut build-universe --input genome.fasta --output model.xml

For a list of available commands:

carvemegut --help

Python API

You can also use CarveMeGut as a Python module:

import carvemegut

model = carvemegut.build_universe("genome.fasta")
model.save("model.xml")

Configuration

CarveMeGut allows customization through a configuration file (config.cfg). This file contains parameters for model reconstruction, database paths, and computational settings.

Data Sources

CarveMeGut integrates with multiple external metabolic databases, including:

  • BiGG Models
  • MetaNetX
  • KEGG

Contributing

We welcome contributions! To contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature-branch)
  3. Commit changes (git commit -m "Add new feature")
  4. Push to the branch (git push origin feature-branch)
  5. Open a Pull Request

License

CarveMeGut is released under the MIT License.

Contact

For questions or issues, please open an issue on GitHub.

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

carvemegut-0.3.7.tar.gz (34.0 kB view details)

Uploaded Source

Built Distribution

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

carvemegut-0.3.7-py3-none-any.whl (51.0 kB view details)

Uploaded Python 3

File details

Details for the file carvemegut-0.3.7.tar.gz.

File metadata

  • Download URL: carvemegut-0.3.7.tar.gz
  • Upload date:
  • Size: 34.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.0

File hashes

Hashes for carvemegut-0.3.7.tar.gz
Algorithm Hash digest
SHA256 32a34693b75c941037f5362c2313a5cd8b46e32bd98e2065f8d28ed6835a8a69
MD5 c40a70715e1d37af5aa3b24540ba2bbb
BLAKE2b-256 f86e5e2c1c7a0687425ffd7dc3948aea65d2c893396a956e72913d7fde355c48

See more details on using hashes here.

File details

Details for the file carvemegut-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: carvemegut-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 51.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.0

File hashes

Hashes for carvemegut-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 3f4cc3e5de212d5bf3052567c12e272df579e6cb46b792b615216076281832ec
MD5 ce2d93b5896bbc3970b8b066e01d0a5a
BLAKE2b-256 d4ea348fefa8e26fcddc36f4865f92068efcde08207d49daa4807411f88c4318

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