yansonggu / jazzy Goto Github PK

• Eike Caldeweyher
• Gian Marco Ghiandoni

Jazzy is an efficient computational tool for the calculation of hydration free energies and hydrogen-bond acceptor and donor strengths. A publication describing the implementation, fitting, and validation of Jazzy can be found at doi.org/10.1038/s41598-023-30089-x.

• Hydration free energies
• Hydrogen-bond strengths
• Visualisation functions (SVG)
• Application programming interface
• Command-line interface

click         # Composable command line interface toolkit
kallisto      # Atomic and molecular featurizer
numpy         # NumPy array computing package
rdkit         # Chemoinformatics toolkit

You can install Jazzy via pip from PyPI:

$ pip install jazzy

Requirements to install Jazzy from sources:

• poetry
• pyenv or conda
• python>=3.6

First check that poetry is running correctly (v1.0.10 at the time of writing)

$ poetry --version
Poetry version 1.0.10

Create a virtual environment (via pyenv or conda) and activate it. Afterwards, clone the Jazzy project from GitHub and install it using poetry

$ git clone [email protected]:AstraZeneca/jazzy.git
$ cd jazzy
$ poetry install

Please see the Usage and Cookbook sections for details.

Jazzy is an open project in every shape and form, thus feedback on how to improve its documentation or functionalities is always welcome. To learn more, see the Contributor Guide.

Distributed under the terms of the Apache 2.0 license, Jazzy is free and open source software.

If you encounter any problems, please file an issue along with a detailed description.

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.