Chemical Hierarchy Approximation for secondary Metabolism clusters Obtained In Silico.
🗺️ ️Overview
CHAMOIS is a fast method for predicting chemical features of natural products
produced by Biosynthetic Gene Clusters (BGCs) using only their genomic
sequence. It can be used to get chemical features from BGCs predicted in
silico with tools such as GECCO or
antiSMASH.
CHAMOIS is implemented in Python, and supports
all versions from Python 3.7 onwards.
It requires additional libraries that can be installed directly from
PyPI, the Python Package Index.
$ pip install chamois-tool
Installing the package is instantaneous, but requires downloading an extra
44 MiB of data (profile HMMs) from GitHub, which will add to the install
time depending on the speed of your Internet connection.
Since release v0.2.1, CHAMOIS can now run on Windows! This uses
the PyHMMER v0.12.0 experimental MinGW-w64
build which supports Windows 10 and later. See the PyHMMER
documentation for more information about
Windows support.
🧬 Running CHAMOIS
Once CHAMOIS is installed, you can run it from the terminal by providing
it with one or more GenBank file the genomic records of the BGCs to analyze,
and an output path where to write the results in HDF5 format. For instance to
predict the classes for BGC0000703,
a kanamycin-producing BGC from MIBiG:
This takes about 3 seconds and 600 MiB of RAM on a higher-end laptop
(Linux 6.13.8, i7-1255U @ 4.70 GHz). The runtime and memory usage scales
linearly with the number of BGCs to process.
Additional examples for running CHAMOIS can be found in the online
documentation.
🔎 Viewing results
The output file can be loaded with the anndata package, and corresponds
to a probability matrix where rows are the input BGCs, and columns are the
ChemOnt classes.
To get a summary for each predicted BGC, use the render command:
$ chamois render -i tests/data/BGC0000703.4.hdf5
Predictions for each BGC will be shown as a tree with their computed
probabilities:
Training CHAMOIS is also done with the CLI, provided you have training data
available. You can use the CHAMOIS datasets
released on Zenodo to reproduce our results.
For instance, to train on the MIBiG 3.1 BGCs, the dataset used to train
the CHAMOIS classifier distributed with the code, run the following command:
This takes about 12 seconds and 600 MiB of RAM on a higher-end laptop
(Linux 6.13.8, i7-1255U @ 4.70 GHz).
📝 Requirements
🖥️ System requirements
CHAMOIS is a pure-python package but requires HMMER, which only runs on
PowerPC, x86-64 and Aarch64 systems, and only on POSIX operating systems
(Linux, MacOS, BSD, Windows w/ MinGW-w64).
CHAMOIS is tested on Linux (Ubuntu 22.04) using the GitHub Actions continuous
integration platform.
🐍 Software requirements
CHAMOIS supports (and is tested) on all Python versions from Python 3.7 onwards.
It requires the following Python packages:
Minimum
Tested
Latest
anndata
>=0.8
0.9.2
gb-io
>=0.3.1
0.3.4
lz4
>=4.0
4.3.3
numpy
>=1.0
2.2.4
pandas
>=1.3
2.2.3
platformdirs
>=3.0
4.3.6
pyhmmer
>=0.11.0
0.11.0
pyrodigal
>=3.0
3.6.3
rich
>=12.4
13.9.4
rich-argparse
>=1.1
1.6.0
scipy
>=1.4
1.15.2
🔖 Reference
CHAMOIS can be cited using the following preprint:
Machine learning inference of natural product chemistry across biosynthetic gene cluster types.
Martin Larralde, Georg Zeller.
bioRxiv 2025.03.13.642868; doi:10.1101/2025.03.13.642868
💭 Feedback
⚠️ Issue Tracker
Found a bug ? Have an enhancement request ? Head over to the GitHub issue
tracker if you need to report
or ask something. If you are filing in on a bug, please include as much
information as you can about the issue, and try to recreate the same bug
in a simple, easily reproducible situation.
🏗️ Contributing
Contributions are more than welcome! See CONTRIBUTING.md
for more details.
🐐 CHAMOIS
Chemical Hierarchy Approximation for secondary Metabolism clusters Obtained In Silico.
🗺️ ️Overview
CHAMOIS is a fast method for predicting chemical features of natural products produced by Biosynthetic Gene Clusters (BGCs) using only their genomic sequence. It can be used to get chemical features from BGCs predicted in silico with tools such as GECCO or antiSMASH.
💡 Usage
This section shows only the basic commands for installing and running CHAMOIS. The online documentation contains a more detailed installation guide, examples, an API reference, and a CLI reference
🔧 Installing CHAMOIS
CHAMOIS is implemented in Python, and supports all versions from Python 3.7 onwards. It requires additional libraries that can be installed directly from PyPI, the Python Package Index.
Installing the package is instantaneous, but requires downloading an extra 44 MiB of data (profile HMMs) from GitHub, which will add to the install time depending on the speed of your Internet connection.
Since release
v0.2.1, CHAMOIS can now run on Windows! This uses the PyHMMERv0.12.0experimental MinGW-w64 build which supports Windows 10 and later. See the PyHMMER documentation for more information about Windows support.🧬 Running CHAMOIS
Once CHAMOIS is installed, you can run it from the terminal by providing it with one or more GenBank file the genomic records of the BGCs to analyze, and an output path where to write the results in HDF5 format. For instance to predict the classes for BGC0000703, a kanamycin-producing BGC from MIBiG:
This takes about 3 seconds and 600 MiB of RAM on a higher-end laptop (Linux 6.13.8, i7-1255U @ 4.70 GHz). The runtime and memory usage scales linearly with the number of BGCs to process.
Additional examples for running CHAMOIS can be found in the online documentation.
🔎 Viewing results
The output file can be loaded with the
anndatapackage, and corresponds to a probability matrix where rows are the input BGCs, and columns are the ChemOnt classes.To get a summary for each predicted BGC, use the
rendercommand:Predictions for each BGC will be shown as a tree with their computed probabilities:
🎛️ Training CHAMOIS
Training CHAMOIS is also done with the CLI, provided you have training data available. You can use the CHAMOIS datasets released on Zenodo to reproduce our results.
For instance, to train on the MIBiG 3.1 BGCs, the dataset used to train the CHAMOIS classifier distributed with the code, run the following command:
This takes about 12 seconds and 600 MiB of RAM on a higher-end laptop (Linux 6.13.8, i7-1255U @ 4.70 GHz).
📝 Requirements
🖥️ System requirements
CHAMOIS is a pure-python package but requires HMMER, which only runs on PowerPC, x86-64 and Aarch64 systems, and only on POSIX operating systems (Linux, MacOS, BSD, Windows w/ MinGW-w64).
CHAMOIS is tested on Linux (Ubuntu 22.04) using the GitHub Actions continuous integration platform.
🐍 Software requirements
CHAMOIS supports (and is tested) on all Python versions from Python 3.7 onwards. It requires the following Python packages:
🔖 Reference
CHAMOIS can be cited using the following preprint:
💭 Feedback
⚠️ Issue Tracker
Found a bug ? Have an enhancement request ? Head over to the GitHub issue tracker if you need to report or ask something. If you are filing in on a bug, please include as much information as you can about the issue, and try to recreate the same bug in a simple, easily reproducible situation.
🏗️ Contributing
Contributions are more than welcome! See
CONTRIBUTING.mdfor more details.⚖️ License
This software is provided under the GNU General Public License v3.0 or later. CHAMOIS is developped by the Zeller Lab at the European Molecular Biology Laboratory in Heidelberg and the Leiden University Medical Center in Leiden.