Skip to main content

Extract, Retrieve and Predict kcat values for a metabolic model to run enzyme constrained metabolic pipelines.

Project description

WILDkCAT

pypi stable documentation

WILDkCAT is a set of scripts designed to extract, retrieve, and predict enzyme turnover numbers (kcat) for genome-scale metabolic models.


Installation

Install WILDkCAT directly from PyPI:

pip install wildkcat

Environment Setup

Provide your BRENDA login credentials and Entrez API email adress to query the BRENDA enzyme database and NCBI database.

Create a file named .env in the root of your project with the following content:

ENTREZ_EMAIL=your_registered_email@example.com
BRENDA_EMAIL=your_registered_email@example.com
BRENDA_PASSWORD=your_password

[!IMPORTANT]

  • Replace the placeholders with the credentials from the account you created on the BRENDA website.
  • Ensure this file is not shared publicly (e.g., add .env to your .gitignore) since it contains sensitive information.
  • The scripts will automatically read these environment variables to authenticate and retrieve kcat values.

Usage

WILDkCAT can be used as scripts or via the CLI.

Command-Line Interface (CLI)

After installation, you can use the WILDkCAT CLI:

wildkcat --help

Example Workflow:

# Extract kcat data
wildkcat extraction \
    path/to/my_model.json \
    path/to/folder_output

# Retrieve kcat values from databases
wildkcat retrieval \
    path/to/folder_output
    'Organism name' \
    20 30 \  # Temperature range
    6.5 8.5 \  # pH range

# Generate input for CataPro
wildkcat prediction-part1 \
    path/to/folder_output
    6  # Limit matching score 

# Integrate CataPro prediction
wildkcat prediction-part2 \
    path/to/folder_output
    prediction_output.csv \
    6  # Limit matching score

# Generate summary report (IN PROGRESS)
wildkcat report \
    path/to/my_model.json \
    path/to/folder_output

[!WARNING]
Currently, the SABIO-RK database is experiencing server overload and queries can be very slow, especially for large models. In these cases, it is recommended to use only the 'brenda' database in the retrieval command.


Programatic Access

from wildkcat import run_extraction, run_retrieval, run_prediction_part1, run_prediction_part2, generate_summary_report

Example: E. coli Core Model

A ready-to-run example is available here. It demonstrates a full extraction, retrieval, and prediction workflow on the E. coli core model.


Key scripts

extract_kcat.py

  • Verifies whether the reaction EC number exists.
  • Retains inputs where reaction-associated genes/enzymes are not supported by KEGG.
  • Retains inputs where no enzymes are provided by the model.
  • If multiple enzymes are provided, searches UniProt for catalytic activity.

retrieve_kcat.py

  • If the same enzyme is not found, computes identity percentages relative to the identified catalytic enzyme.
  • Applies Arrhenius correction to values within the appropriate pH range.
  • For rows with multiple scores, selects:
    • The best score
    • The highest identity percentage
    • The lowest kcat value

predict_kcat.py

  • If multiple enzymes are provided, searches UniProt for catalytic activity.
  • Skips entries missing KEGG compound IDs.

Feedback & Improvements

Contributions, suggestions, and feedback are very welcome! If you encounter any issues, have ideas for new features, or notice room for improvement, feel free to open an issue or submit a pull request.

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

wildkcat-0.0.20.tar.gz (94.5 kB view details)

Uploaded Source

Built Distribution

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

wildkcat-0.0.20-py3-none-any.whl (42.6 kB view details)

Uploaded Python 3

File details

Details for the file wildkcat-0.0.20.tar.gz.

File metadata

  • Download URL: wildkcat-0.0.20.tar.gz
  • Upload date:
  • Size: 94.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wildkcat-0.0.20.tar.gz
Algorithm Hash digest
SHA256 2ee93266ed2bf36b40d1b4ff0d8b05ff5fbeec1ff062616040cb5fa6523f85a8
MD5 15a190090bee8c387c3913117eb16a2a
BLAKE2b-256 2a748cdb5803f0f18c3663654a0a2ec9015afcffc6740c07ab8e0ba01ab0e2a3

See more details on using hashes here.

File details

Details for the file wildkcat-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: wildkcat-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 42.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wildkcat-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 9adfd47c5506fa2df9996ed781115173d9a6751981002724d587ee5d6e0a2c53
MD5 7791e0585138df43e5cfb4bc152bc25f
BLAKE2b-256 c7bd53c53b9fc20c3cc22768ed5e6612a30ef81877005083ae3cf66c950e2835

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