Skip to main content

A wrapper for xtb

Project description

Introduction

SCINE XTB Wrapper is a wrapper around xtb, it exports:

  • GFN0-xTB

  • GFN1-xTB (formerly GFN-xTB)

  • GFN2-xTB

  • GFN-FF

into the SCINE tool chain. Each method is represented by its own Calculator and the entire wrapper constitutes a SCINE module that can be loaded dynamically at runtime. For more information on these concepts see the Scine::Core repository.

Installation and Usage

The wrapper can be built and installed using the following commands:

export INSTALL_PATH=<desired path>
git submodule init
git submodule update
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DSCINE_BUILD_PYTHON_BINDINGS=ON -DCMAKE_INSTALL_PREFIX=$INSTALL_PATH ..
make -j<number of cores to use>
make install

This will generate and install both the main xtb code and the wrapper in the form of the file xtb.module.so that can be used in SCINE.

In order to make XTB available to SCINE the following two environment variables need to be set:

export XTBPATH=$INSTALL_PATH/share/xtb
export SCINE_MODULE_PATH=$SCINE_MODULE_PATH:$INSTALL_PATH/lib

Afterwards, SCINE programs such as ReaDuct will pick up XTB’s existence and it will be possible to request the implemented methods.

The SCINE XTB wrapper is also available via Python. The underlying SCINE module can be loaded and its implemented calculators accessed using the standard scine_utilities Python bindings. A minimal workflow could look like this:

import scine_utilities as su
import scine_xtb_wrapper

# Generate Structure
structure = su.AtomCollection()
structure.elements = [su.ElementType.H, su.ElementType.H]
structure.positions = [[-0.7, 0, 0], [0.7, 0, 0]]

# Get calculator
calculator = su.core.get_calculator('GFN2', 'xtb')

# Configure calculator
calculator.structure = structure
calculator.set_required_properties([su.Property.Energy, su.Property.Gradients])

# Calculate
results = calculator.calculate()
print(results.energy)
print(results.gradients)

How to Cite

When publishing results obtained with the SCINE XTB wrapper, please cite the corresponding release as archived on Zenodo (DOI 10.5281/zenodo.5782861; please use the DOI of the respective release).

This wrapper should also not be mistaken for the actual xtb code it wraps. For the latter code and its citations, we refer you to the original xtb repository. There you will find the references of the actual methods used. They are listed in the README.md.

Support and Contact

In case you should encounter problems or bugs with the wrapper, please write a short message to scine@phys.chem.ethz.ch.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

scine_xtb_wrapper-2.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.6 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

scine_xtb_wrapper-2.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.6 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

scine_xtb_wrapper-2.0.0-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.6 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

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