Skip to main content

Konnektor is a package for calculating networks.

Project description

Konnektor`s fancy logo

Konnektor: Tools for Networks in your FE Calculations

Logo build coverage Documentation Status

Pip Install

Konnektor is a package supporting you in planning your free calculations. It contains multiple algorithms and tools for network planning, that make setting up the calculation plans much easier. As an example imagen you are given a set of drug candidates that shall be ranked with relative binding free energies. In theory you could calculate all the possible network transformations, in order to get your ligand ranking (we call this a Maximal Network). However this leads to an explosion in time and compute cost, therefore we need more efficient ways on how to caluclate a drug candidate ranking. From a thermodynamic perspective not all transformations are actually required to retrieve a ranking. In fact you only need one conection per small molecules to the others in order to get the ranking, like for example in Star Networks or Minimal Spanning Tree (MST) Networks. However we found the very efficient networks to be sensitive to transformation failures, this can be solved with network building algorithms, that are slightly more redundant.

Ontop of the described ligand network planners, Konnektor gives access to tools, that allow for example to concatenate networks or delete transformations of a network. Analysis of networks, like calculating graph scores, getting the connectivities of network nodes or calculating the network robustness are available too. Last we want to bring to your attention our Network visualization tools and the provided interactive network visualization widget for IPython like in Jupyter-Lab/Notebooks.

Try our interactive demo: Open In Colab

For more information checkout our pre-print: Konnektor: A framework for using graph theory to plan networks for free energy calculations

Content

Implemented Network Layouts

Several Network layout generating algorithms are implemented in Konnektor, with different advantages and disadvantages. From an algorithmic perspective most of the algorithms are actually a reduction method of the Maximal Network. To speed-up the Maximal Network Algorithm we implemented an parallelization scheme to it. Below you can find some of our layouts:

image

Tools for handling Networks

Konnektor implements tools, that allow for example to merge (if a node is shared in the networks) or concatenate (if no node is shared) networks, append single molecules (nodes) to a network or delete transformations/molecules from a network.

image

Enable More Complex Higher Order Networks

Another goal of Konnektor is to go beyond the standard network layout algorihtms and allow easy implementation of more complex network algorithms. This is achieved by combining the Tools and Network Generator Algorithms, to build up to more advanced workflows.

image

Code Example

# Here we generate some input data.
from konnektor.data import get_benzene_ligands

compounds = list(filter(lambda x: not x.name in ["lig_2", "lig_3", "lig_4", "lig_7"],
                        get_benzene_ligands()))

# Pick your Favourite Network layout with favourite AtomMapper and Scorer
from openfe.setup import KartografAtomMapper, lomap_scorers
from konnektor.network_planners import CyclicNetworkGenerator

networker = CyclicNetworkGenerator(mappers=KartografAtomMapper(),
                                   scorer=lomap_scorers.default_lomap_score)

# Generate Network
network = networker.generate_ligand_network(compounds)
network.name = "Cyclic Network"

# Visualize the generated network
from konnektor.visualization import draw_ligand_network
fig = draw_ligand_network(network=network, title=network.name)

fig.show()

example fig

Installation

Latest release

Konnektor can be installed via the package following package managers:

pip install konnnektor

Developement version

The developing setup of Konnektor works like this:

git clone https://github.com/OpenFreeEnergy/konnektor.git

cd konnektor
mamba env create -f environment.yml

mamba activate konnektor
pip install -e .

License

This library is made available under the MIT open source license.

Authors

The OpenFE development team.

Acknowledgments

Thanks to Enrico Ruijsenaars, Jenke Scheen and Josh Horton for great discussions!

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

konnektor-0.1.0.tar.gz (119.3 kB view details)

Uploaded Source

Built Distribution

konnektor-0.1.0-py3-none-any.whl (167.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: konnektor-0.1.0.tar.gz
  • Upload date:
  • Size: 119.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for konnektor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6cded252eb079341b884b609e524f38ec96387efb343bd3f2312fae4de5c1166
MD5 d8f1771ec861dd706a3f862db2640e5a
BLAKE2b-256 f1861c5628f2edd3a88c7f504c9e37601f3eb1b21c74f2e8959177568fd20e29

See more details on using hashes here.

File details

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

File metadata

  • Download URL: konnektor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 167.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for konnektor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 582ce6683d13714dc640fc52b7fef0f2dcf6cdf0d36197a0b3f7aaae21b32edc
MD5 48d9a3ea33d63787bed4839eeab9e61c
BLAKE2b-256 a579bc8b300a14fd336384cd3726c8fc52932e02d1c7426ff7fea96020d3ee15

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page