Skip to main content

BioBrigit

BioBrigit is a computational tool designed for the prediction of metal diffusion pathways through a protein. It uses a novel scoring function that combines deep learning and previous domain knowledge regarding bioinorganic interactions. The deep learning part of our hybrid approach consists on a 3D Convolutional Neural Network trained to interpret the biochemical environment to distinguish between metal-binding and non-binding protein regions.

Shows an stylised anvil with a neural network upon it.

Useful links

Features

Diferent options for customizing the search:

  • Search for the paths of specific metals.
  • Provide a score that indicates how strong the protein-metal interaction will be in different positions.
  • Scan the whole protein or only a region (in PDB format).

Possible applications:

  • Identification of probable metal diffusion pathways through a protein.
  • Identification of conformational changes that alter the formation of such paths.
  • Metalloenzyme and metallodrug design.
  • Aid in developing hypothesis in molecular physiopathology.
  • Drug discovery.

Modular design:

  • The modular design of this package allows for its use as a command-line application or to be integrated into a larger Python program or pipeline. In the script directory are some of examples on how to integrate the program within a wider pipeline.

Installation

It can be directly installed in any conda environment by

conda create -n biobrigit python
conda activate biobrigit
pip install biobrigit

Usage

Once the environment is properly set-up the use of the program is relatively simple. The easiest example is:

biobrigit target metal

There are many parameters that can be also tuned, though default use is reccomended.

  • --model: Which CNN model is to be used. Two options are currently available: BrigitCNN which is the default model and TinyBrigit, which is a smaller model for improved computational efficiency, though it has lower accuracy.
  • --device: Whether to use GPU acceleration (cuda) or not (cpu). By default, it uses GPU if available.
  • --device_id: Which of the available GPU devices should be used for the calculations in case that there are more than one GPU available. By default, it uses the device labelled as 0.
  • --outputfile: Name of the outputfiles. The file extensions (.txt and .pdb) will be added automatically.
  • --max_coordinators: Number of maximum coordinators expected. By default, 2. It only affects the range of values assigned to the probes.
  • --residues: Number of most likely coordinating residues. By default, 10.
  • --stride: Step at which the voxelized representation of the protein should be parsed. By default, 1. The greater the stride, the greater the computational efficiency; however, the resolution of the predictions will be affected.
  • --cluster_radius: Radius of the clusters to be generated in armstrongs. By default, 5.
  • --cnn_threshold: Threshold for considering CNN points as possible coordinations. Lower values will impact computational efficiency; greater values, may hide possible coordinating regions. By default, 0.5. Values should be within the range [0, 1].
  • --combined_threshold: Threshold for considering predictions combining BioMetAll and CNN scores as positive. By default, 0.5. Values should be within the range [0, 1].
  • --threads: Number of threads available for multithreading calculation. By default it will create 2 threads per physical core.
  • --verbose: Information that will be displayed. 0: Only Moleculekit, 1: All. By default, 1.
  • --residue score: Scoring function for residue coordination analysis. Can be either discrete, that only considers how likely is a residue to bind to a certain metal (more computationally efficient); or gaussian, that also considers the fitness of the geometrical descriptors for a certain residue and metal. By default, gaussian.

The following parameters can also be tuned, but their modification is not reccomended as it may translate in unreliable predictions.

  • --cnn_weight: Importance of the CNN score in the final score in relations to the BioMetAll score. By default, 0.5. Values should be within the range [0, 1].
  • --voxelsize: Resolution of the 3D representation. In Arnstrongs. By default, 1 A.
  • --pH: pH of the medium at which the structure is to be evaluated. By default, 7.4.

Examples:

Searching for copper.

biobrigit 1dhy Cu

Searching with generic metal.

biobrigit 1dhy generic

Searching for multiple metals simultanously.

biobrigit 1dhy fe,generic

Fast preliminar exploration for binding sites with 4 coordinations, no GPU, and only considering the 4 most likely coordinating residues.

biobrigit 1dhy Cu --stride 3 --max_coordinators 4 --device cpu --residues 4

Search for small clusters at acidic pH (5.2).

biobrigit 1dhy Cu --cluster_radius 3 --pH 5.2

Output

The program generates 2 output files.

  1. A .txt file that contains information regarding the clusters of probes ordered by the predicted strength of the interaction between protein and metal. This file also displays a list of possible coordinating residues.
  2. A .pdb file that contains the coordinates of all probes with a score greater than combined_threshold and is the recommended output format for visualizing the predicted paths. The probes are represented as He atoms and the centers of their clusters as Ar atoms. To easily visualise the score for each probe, simply colour the probes by their $\beta$-factor using your protein visualization tool of choice.

License

BioBrigit is an open-source software licensed under the BSD-3 Clause License. Check the details in the LICENSE file.

Development Team

Credits

Special thanks to Silvia González López for designing the BioBrigit logo.

Metadata

Release files for biobrigit 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for biobrigit 1.0.0
File Size Uploaded Provenance
biobrigit-1.0.0.tar.gz 20.0 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for biobrigit 1.0.0
File Interpreter ABI Platform
biobrigit-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 60.1 MB

Release files / biobrigit-1.0.0.tar.gz

Download URL biobrigit-1.0.0.tar.gz
Size 20.0 MB
Tags Source
SHA-256 checksum
How to use checksums
9ab3ad8547d24c27550e474fcff9d3730114b890204fc17e57901e3bcb672440
BLAKE2b-256 checksum
How to use checksums
a806a4c5f409712c38f490a1519d5bb2ee804bfa6702631cb1569890fbc412fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 12, 2025.

Transparency log

Release files / biobrigit-1.0.0-py3-none-any.whl

Download URL biobrigit-1.0.0-py3-none-any.whl
Size 40.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3e9cc4851bb8fee00b5635981080aadbdac44a200397ecd849d68f216b1a1df1
BLAKE2b-256 checksum
How to use checksums
43ee08aada45743dcc4a39b75817c85e1fb0954cec37513423f4ebc8ab11e4e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 12, 2025.

Transparency log

Security for biobrigit 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for biobrigit-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 12, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page