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.

[!WARNING] WILDkCAT is currently in 'beta' version. Some parameters (such as the penalty score) are not yet finalized and some features are still under development. Please do not hesitate to try the package, share your experience, and report any issues or suggestions by opening an issue on the Issues page.


WILDkCAT produces a .tsv file with the retrieved and predicted kcat values for each combination of enzyme, substrates in your genome-scale metabolic model. Each step of the pipeline also generates an HTML report that provides detailed information about the retrieval process to facilitate transparency and reproducibility. The HTML reports are generated automatically after each stage of the workflow (extractionn, retrieval, prediction) and can be opened directly in any web browser.

WILDkCAT Report Demo

Access the report here

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
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 closest organism (if sequence is not available)
    • The highest 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.1.0.tar.gz (99.7 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.1.0-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wildkcat-0.1.0.tar.gz
Algorithm Hash digest
SHA256 05317e0c6c4ebc8644fce83d4b2221178551fa443e2f4f0d5a15d54aec197884
MD5 eb724f8ff140a0f7a023f067ade87af8
BLAKE2b-256 d36597a0bd8d75d930d4c046bb2b7f5e1712f9621f1a530ec7d98d9290992bd5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wildkcat-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.8 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70350328e452fe2f74c827a6522fa0fd86399e35a5bb972ab31c69bcc85cd7ce
MD5 254d7f77745c4ee2a36951b1566869cf
BLAKE2b-256 daae6606bb4bbb975dcb8b8c0deaa7d3c3522a75187d50ea8cd10bc1b48e38d7

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