Detect catalytic enzyme residues in protein structures by matching a library of known templates.
Project description
EnzyMM - The Enzyme Motif Miner 
️Overview
Enzyme Motif Miner uses geometric template matching to identify known arrangements of catalytic residues called templates in protein structures. It searches protein structures provided by the user against a database of templates. EnzyMM ships with a library of catalytic templates derived from the Mechanism and Catalytic Site Atlas (M-CSA) but you can also generate your own. These templates represent consensus arrangements of catalytic sites found in active sites of experimental protein structures.
As catalytic sites are both highly conserved and absolutely critical for the function of a protein, identifying them offers many biological insights. This method has two key advantages. Firstly, as it doesn't rely on sequence or (global) fold similarity, similar catalytic arrangements can be found accross great evolutionary distances offering insights into the divergence or even convergence of enyzmes. Secondly, as geometric matching is very fast, EnzyMM scales along side databases of predicted protein structures. Expect to scan a protein structure in a matter of seconds on consumer laptops.
As a database driven method, EnzyMM is inherently limited by the coverage of residue arrangements in its template library. The provided template library covers nearly the entire M-CSA and thus around 3/4 of enzyme mechanisms classified by the Enzyme Commission to the 3rd level. Catalytic arrangements not found in the PDBe won't be included in the M-CSA. Of course, the user can also provide their own library of templates. While primarily intended for catalytic sites, you are invited to search with your own library of templates.
For the actual geometric matching EnzyMM relies on PyJess - a Cython wrapper of Jess.
🔧 Installing EnzyMM
EnzyMM is implemented in Python,
and supports all versions from Python 3.8 on Linux and MacOS. It requires
additional libraries that can be installed directly from
PyPI, the Python Package Index.
Use pip to install EnzyMM on your
machine:
$ pip install enzymm
This will both install EnzyMM and also download a library of catalytic templates together with important metadata. This requires around 16MB of data to be downloaded.
It should also run on windows (though this is not tested for on release).
🖼️ Images
Lightweight images built from python:3.13-alpine are available:
Pull the latest Docker image from GHCR:
docker pull ghcr.io/rayhackett/enzymm:latest
Pull the latest Apptainer image via ORAS from GHCR:
apptainer pull oras://ghcr.io/rayhackett/enzymm:latest
🔎 Running EnzyMM
Once EnzyMM is installed, you can run it from the terminal. The user can either provide a path to a single protein structure -i or to run multiple queries at once, the path to a text file -l which itself contains a list of paths to protein structures.
Optionally, an output directory for pdb structures of the identified matches per query protein can be supplied with the --pdbs flag.
$ enzymm -i some_structure.pdb -o results.tsv --pdbs dir_to_save_matches
Additional parameters of interest are:
--n-jobsor-n, which controls the number of threads used to parallelize the search. By default, it will use one thread less than available on your system usingos.cpu_count.--unfilteredor-u, which disables filtering of matches by RMSD and residue orientation. By default, filtering is enabled.--skip-smaller-hits, which skips searches with smaller templates on a query if a match to a larger template has already been found.--jessor-j, which controls the RMSD threshold and pairwise distance threshold applied. By default sensible thresholds are selected. Refer to the Docs for details--template-diror-t, though which the user may supply their own template library. By default, a library of catalytic templates derived from the M-CSA is loaded.--conservation-cutoffor-c, which can be set to exclude atoms with B-factors or pLDDT scores below this threshold from matching. This is not set by default.
Further, EnyzMM is designed with modularity in mind and comes with a fully usable internal API.
Please refer to the Docs for further reference.
🖹 Results
EnzyMM will create a single output file:
{output}.tsv: A.tsvfile containing a summary of all results. One row is printed per match.
For visual exploration of matches, you can optionally save an alignment of the template and the matched query residues to a pdb file which can be viewed with any pdb viewer.
To do so, supply an output directory after the --pdbs flag for the .pdb files.
This will also create:
{pdbs_dir}/{query_identifier}_matches.pdb: One.pdbfile per query with a structural alignment between template and query residues. This can be further configured.
Add additional information to each .pdb file with the following flags:
--transform, which causes the query to be aligned to the the template instead of vice versa.--include-query, which also writes the entire query pdb structure to the.pdbfile
Currently, --transform and --include-query should not be used together.
Hopefully I'll get around to fixing this soon.
💭 Feedback
⚠️ Issue Tracker
Please report any bugs or feature requests though the GitHub issue tracker.
Please also feel free to ask any questions and I will do my best to answer them.
If reporting a bug, please include as much information as you can about the issue and try to recreate the same bug.
Ideally include a little test example so I can quickly troubleshoot.
🏗️ Contributing
Contributions are more than welcome!
Raise an issue or shoot me an email under r.e.hackett AT lumc.nl
I'm happy to help.
📋 Changelog
This project adheres to Semantic Versioning and provides a changelog in the Keep a Changelog format.
⚖️ License
This software is provided under the open source MIT licence.
Though conceived at the EMBL-EBI in Hinxton, UK in the Thornton Group, EnzyMM is now developed by Raymund Hackett and the Zeller Group at the Leiden University Medical Center in Leiden in the Netherlands with continuing support from the Thornton Group.
🔖 Citations
EnyzMM is academic software but relies on many previous approaches.
EnzyMM itself can not yet be cited but a preprint is in preparation.
We intend to publish during the summer of 2025.
We kindly ask you to cite both:
- PyJess, for instance as:
PyJess, a Python library binding to Jess (Barker et al., 2003).
- Mechanism and Catalytic Site Atlas as:
Ribeiro AJM et al. (2017), Nucleic Acids Res, 46, D618-D623. Mechanism and Catalytic Site Atlas (M-CSA): a database of enzyme reaction mechanisms and active sites. DOI:10.1093/nar/gkx1012. PMID:29106569.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file enzymm-0.1.1.tar.gz.
File metadata
- Download URL: enzymm-0.1.1.tar.gz
- Upload date:
- Size: 12.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
936d54eab17128b1744561a6c4a5110089ba6becff1c1002cfba04c62d2c287b
|
|
| MD5 |
38d9a45204c1bdca7bc232ba6b5634c8
|
|
| BLAKE2b-256 |
3b8bd3893a78e5698d7db7b1d77a0a3bf86619da6d265947168d985bbf8d6ce1
|
Provenance
The following attestation bundles were made for enzymm-0.1.1.tar.gz:
Publisher:
test.yml on RayHackett/enzymm
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
enzymm-0.1.1.tar.gz -
Subject digest:
936d54eab17128b1744561a6c4a5110089ba6becff1c1002cfba04c62d2c287b - Sigstore transparency entry: 414341177
- Sigstore integration time:
-
Permalink:
RayHackett/enzymm@1094cde4c1454729e20b2d6c2762a991ad661a83 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/RayHackett
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
test.yml@1094cde4c1454729e20b2d6c2762a991ad661a83 -
Trigger Event:
push
-
Statement type:
File details
Details for the file enzymm-0.1.1-py3-none-any.whl.
File metadata
- Download URL: enzymm-0.1.1-py3-none-any.whl
- Upload date:
- Size: 18.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bb67ef0d584407ec6c56a5af0c5cc14a8c82b2e2413e531ef85c4885487c8fcf
|
|
| MD5 |
43f48192dae6c7bd17b8d31be21507b8
|
|
| BLAKE2b-256 |
e49c0e3286858d1aba966cc4420defe9df7c724282435f7207ffdfb27fa0c31b
|
Provenance
The following attestation bundles were made for enzymm-0.1.1-py3-none-any.whl:
Publisher:
test.yml on RayHackett/enzymm
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
enzymm-0.1.1-py3-none-any.whl -
Subject digest:
bb67ef0d584407ec6c56a5af0c5cc14a8c82b2e2413e531ef85c4885487c8fcf - Sigstore transparency entry: 414341181
- Sigstore integration time:
-
Permalink:
RayHackett/enzymm@1094cde4c1454729e20b2d6c2762a991ad661a83 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/RayHackett
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
test.yml@1094cde4c1454729e20b2d6c2762a991ad661a83 -
Trigger Event:
push
-
Statement type: