Skip to main content

Automation of computations in quantum chemistry.

Project description

https://github.com/SCM-NV/qmflows/workflows/Tests/badge.svg https://codecov.io/gh/SCM-NV/qmflows/branch/master/graph/badge.svg Documentation Status https://zenodo.org/badge/DOI/10.5281/zenodo.3274284.svg https://badge.fury.io/py/qmflows.svg qmflows.png

QMFlows

See documentation for tutorials and documentation.

Motivation

Research on modern computational quantum chemistry relies on a set of computational tools to carry out calculations. The complexity of the calculations usually requires intercommunication between the aforementioned tools, such communication is usually done through shell scripts that try to automate input/output actions like: launching the computations in a cluster, reading the resulting output and feeding the relevant numerical result to another program. Such scripts are difficult to maintain and extend, requiring a significant programming expertise to work with them. Being then desirable a set of automatic and extensible tools that allows to perform complex simulations in heterogeneous hardware platforms.

This library tackles the construction and efficient execution of computational chemistry workflows. This allows computational chemists to use the emerging massively parallel compute environments in an easy manner and focus on interpretation of scientific data rather than on tedious job submission procedures and manual data processing.

Description

This library consists of a set of modules written in Python3 to automate the following tasks:

  1. Input generation.

  2. Handle tasks dependencies (Noodles).

  3. Advanced molecular manipulation capabilities with (rdkit).

  4. Jobs failure detection and recovery.

  5. Numerical data storage (h5py).

Tutorial and Examples

A tutorial written as a jupyter-notebook is available from: tutorial-qmflows. You can also access direclty more advanced examples.

Installation

  • Download miniconda for python3: miniconda (also you can install the complete anaconda version).

  • Install according to: installConda.

  • Create a new virtual environment using the following commands:

    • conda create -n qmflows

  • Activate the new virtual environment

    • source activate qmflows

To exit the virtual environment type source deactivate.

Dependencies installation

  • Type in your terminal:

    conda activate qmflows

Using the conda environment the following packages should be installed:

  • install rdkit and h5py using conda:

    • conda install -y -q -c conda-forge rdkit h5py

    • Note that rdkit is optional for Python 3.7 and later.

Package installation

Finally install the package:

  • Install QMFlows using pip: - pip install qmflows

Now you are ready to use qmflows.

Notes:

  • Once the libraries and the virtual environment are installed, you only need to type conda activate qmflows each time that you want to use the software.

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

qmflows-1.0.0.tar.gz (77.0 kB view details)

Uploaded Source

Built Distribution

qmflows-1.0.0-py3-none-any.whl (83.9 kB view details)

Uploaded Python 3

File details

Details for the file qmflows-1.0.0.tar.gz.

File metadata

  • Download URL: qmflows-1.0.0.tar.gz
  • Upload date:
  • Size: 77.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for qmflows-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c4b3ba80345d7cb921b582d27c2597caa27d4890067be74de103dec15f9ed5a5
MD5 86fec6fc368d4378c29ce99505a8a81d
BLAKE2b-256 912dfa46e0991258d0bb11b069d85949d679a92b8729f5518ce6fe9deb9495a1

See more details on using hashes here.

Provenance

File details

Details for the file qmflows-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: qmflows-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 83.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for qmflows-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b039ce6017b1178bb288350cf38d8512d2da7b26b541771d776f47fa857eb30
MD5 f114e5b4e50ce5b169bd9e1566c3d17d
BLAKE2b-256 2b1b81de3fe9f816c48bae9c0e95d58d8fb36ee298a245c5e5ae3ed672820c7c

See more details on using hashes here.

Provenance

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