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.4.5.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.4.5-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: carvemegut-0.4.5.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.4.5.tar.gz
Algorithm Hash digest
SHA256 69de5ef344182b3865eda20d23016b77988543a0c782649d8a6b08311e4f1e0f
MD5 37891e1891629d2d1c8688920f1805eb
BLAKE2b-256 e8dbb3753b770cf96b72bbe759f92c10e437076235187efdf872ef39da80a461

See more details on using hashes here.

File details

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

File metadata

  • Download URL: carvemegut-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 50.9 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.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 459c6e61921cbfafd2a36df7c327fac1d536889465108ecc2a1cdf62a511b481
MD5 1f0667e9ea9f207348920c50b9cc2e75
BLAKE2b-256 07ceb615e9b868481a986a562014874d49193d4857eaf967809d03f7310f5713

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