Skip to main content

The Kallisto software enables the efficient calculation of atomic features that can be used within a quantitative structure-activity relationship (QSAR) approach. Furthermore, several modelling helpers are implemented.

Project description

Kallisto

PyPI - Python Version Documentation Maturity Level Tests codecov Language grade: Python status

Table of Contents

  • Full Author List
  • Introduction
  • Installation
  • Testing suite
  • Reference

Full Author List

Introduction

We developed the kallisto program for the efficient and robust calculation of atomic features using molecular geometries either in a xmol or a Turbomole format. Furthermore, several modelling tools are implemented, e.g., to calculate root-mean squared deviations via quaternions (including rotation matrices), sorting of molecular geometries and many more. All features of kallisto are described in detail within our documentation (GitBook repository).

Main dependencies

click 7.1.2 Composable command line interface toolkit
numpy 1.20.1 NumPy is the fundamental package for array computing with Python.
scipy 1.6.0 SciPy: Scientific Library for Python
└── numpy >=1.16.5

For a list of all dependencies have a look at the pyproject.toml file.

Installation from PyPI

To install kallisto via pip use our published PyPI package

pip install kallisto

Installation from Source

Requirements to install kallistofrom sources:

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 kallisto project from GitHub and install it using poetry

> git clone git@github.com:AstraZeneca/kallisto.git
> cd kallisto
> poetry install

Testing suite

The kallisto project uses nox as an automated unit test suite, which is therefore an additional dependency.

Default nox session

The default session includes: linting (lint), type checks (mypy, pytype), and unit tests (tests).

> nox

When everything runs smoothly through, you are ready to go! After one successful nox run, we can reuse the created virtual environment via the -r flag.

> nox -r

Different unit test sessions are implemented (check the noxfile.py). They can be called separately via the run session -rs flag.

Tests

Run all unit tests that are defined in the /tests directory.

> nox -rs tests

Lint

kallisto uses the flake8 linter (check the .flake8 config file).

> nox -rs lint

Black

kallisto uses the black code formatter.

> nox -rs black

Safety

kallisto checks the security of dependencies via safety.

> nox -rs safety

Mypy

kallisto checks for static types via mypy (check the mypy.ini config file).

> nox -rs mypy

Pytype

kallisto furthermore uses pytype for type checks.

> nox -rs pytype

Coverage

Unit test coverage can be checked as well.

> nox -rs coverage

Reference

Always cite:

Eike Caldeweyher, J. Open Source Softw., 2021, 6, 3050. DOI: 10.21105/joss.03050

@article{Caldeweyher2021,
  doi = {10.21105/joss.03050},
  url = {https://doi.org/10.21105/joss.03050},
  year = {2021},
  volume = {6},
  number = {60},
  pages = {3050},
  author = {Eike Caldeweyher},
  title = {kallisto: A command-line interface to simplify computational modelling and the generation of atomic features},
  journal = {J. Open Source Softw.}
}

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

kallisto-1.0.10.tar.gz (104.5 kB view details)

Uploaded Source

Built Distribution

kallisto-1.0.10-py3-none-any.whl (104.7 kB view details)

Uploaded Python 3

File details

Details for the file kallisto-1.0.10.tar.gz.

File metadata

  • Download URL: kallisto-1.0.10.tar.gz
  • Upload date:
  • Size: 104.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.7.8 Darwin/22.6.0

File hashes

Hashes for kallisto-1.0.10.tar.gz
Algorithm Hash digest
SHA256 cf0541129bfebb5a778f1ac1edc8f7d2c4788490f41aa239f7b8e9d65b0a6778
MD5 f3438bd3563e06cb69af0c86cd02c706
BLAKE2b-256 eea6ff2e65d9c53695ec4488fe7757d848d0b1f151479f68cec658fa91a5ac39

See more details on using hashes here.

File details

Details for the file kallisto-1.0.10-py3-none-any.whl.

File metadata

  • Download URL: kallisto-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 104.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.7.8 Darwin/22.6.0

File hashes

Hashes for kallisto-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 d7e908f909f65d57552c6fb7f2948eb5db6aaf6c5019b77d06c8c2cdc1123b71
MD5 ecd545ededcf7e1e10c608ee16ad07ec
BLAKE2b-256 7a90e90f62d1d8d315c50119d183b663c87d8ea14b6084c143fdf5a5ec7f82d5

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