Skip to main content
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.

Metadata

Release files for qmflows 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qmflows 1.0.0
File Size Uploaded
qmflows-1.0.0.tar.gz 77.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qmflows 1.0.0
File Interpreter ABI Platform
qmflows-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 161.0 kB

Release files / qmflows-1.0.0.tar.gz

Download URL qmflows-1.0.0.tar.gz
Size 77.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c4b3ba80345d7cb921b582d27c2597caa27d4890067be74de103dec15f9ed5a5
BLAKE2b-256 checksum
How to use checksums
912dfa46e0991258d0bb11b069d85949d679a92b8729f5518ce6fe9deb9495a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Release files / qmflows-1.0.0-py3-none-any.whl

Download URL qmflows-1.0.0-py3-none-any.whl
Size 83.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4b039ce6017b1178bb288350cf38d8512d2da7b26b541771d776f47fa857eb30
BLAKE2b-256 checksum
How to use checksums
2b1b81de3fe9f816c48bae9c0e95d58d8fb36ee298a245c5e5ae3ed672820c7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.13.0

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.1

2 release files

0.11.0

2 release files

0.2.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page