Skip to main content

Jazzy allows calculating a set of atomic/molecular descriptors including the Gibbs free energy of hydration (kJ/mol), its polar/apolar components, and the hydrogen-bond strength of donor and acceptor atoms.

Project description

Jazzy

PyPI Status Python Version License

Read the documentation at https://jazzy.readthedocs.io/ Tests Codecov

pre-commit Black

Full Author List

  • Eike Caldeweyher

  • Gian Marco Ghiandoni

Introduction

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.

If you are using Jazzy in your research, please remember to cite our publication as:
Ghiandoni, G.M., Caldeweyher, E. Fast calculation of hydrogen-bond strengths and free energy of hydration of small molecules. Sci Rep 13, 4143 (2023)

Features

  • Hydration free energies

  • Hydrogen-bond strengths

  • Visualisation functions (SVG)

  • Application programming interface

  • Command-line interface

Installation via PyPI

You can install Jazzy via pip from PyPI:

$ pip install jazzy

Installation via Poetry (for development)

Requirements to install Jazzy from the code repository:

First check that poetry is running (v1.4.1 at March 2023)

$ poetry --version
Poetry version v1.4.1

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 git@github.com:AstraZeneca/jazzy.git
$ cd jazzy
$ poetry install

If you wish to replicate our parameter fitting (see data/optuna_fitting and optimisation), you need to install the specific version of optuna. At the time of the study, we used optuna==2.3.0. You can install that manually using pip or poetry.

$ poetry install --with optuna
$ pip freeze | grep optuna
optuna==2.3.0

Usage and Cookbook

Please see the Usage and Cookbook sections for details.

Contributing

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.

License

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

Issues

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

Credits

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

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

jazzy-0.1.4.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jazzy-0.1.4-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file jazzy-0.1.4.tar.gz.

File metadata

  • Download URL: jazzy-0.1.4.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/5.10.237-230.949.amzn2.x86_64

File hashes

Hashes for jazzy-0.1.4.tar.gz
Algorithm Hash digest
SHA256 b8f0ef244d03d22b2598c1b582096c8f5cb140f9370b37ac589f42efa2ccbc27
MD5 4c0487ec6924fc7a34a1330da764fc59
BLAKE2b-256 0e2015c7b4e1eec3d5017e4828b61432f42a44285bd000d5143480e17d249e90

See more details on using hashes here.

File details

Details for the file jazzy-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: jazzy-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/5.10.237-230.949.amzn2.x86_64

File hashes

Hashes for jazzy-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b5d50a65c2d90cb6648b963425fb4121a2b80b811f00ee6aa2b4c615d0dfe6e6
MD5 06dced90be1303f0055413d30770d077
BLAKE2b-256 018a055258eacbbdd3bc3e24443283796e5860c2e7ca776e34e522d703d43b53

See more details on using hashes here.

Supported by

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