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).

Furthermore, when publishing results obtained with any SCINE module, please cite the following paper:

T. Weymuth, J. P. Unsleber, P. L. Türtscher, M. Steiner, J.-G. Sobez, C. H. Müller, M. Mörchen, V. Klasovita, S. A. Grimmel, M. Eckhoff, K.-S. Csizi, F. Bosia, M. Bensberg, M. Reiher, “SCINE—Software for chemical interaction networks”, J. Chem. Phys., 2024, 160, 222501 (DOI 10.1063/5.0206974).

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-3.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

scine_xtb_wrapper-3.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

scine_xtb_wrapper-3.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

scine_xtb_wrapper-3.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

scine_xtb_wrapper-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

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

scine_xtb_wrapper-3.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

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

File details

Details for the file scine_xtb_wrapper-3.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: scine_xtb_wrapper-3.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: CPython 3.11, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.2 tqdm/4.51.0 importlib-metadata/4.8.2 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for scine_xtb_wrapper-3.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 62977b3cea1c0ac88c77d24fdf50ce3b471d2f84be33dbb094f8c0121c75a64d
MD5 ecb7035c6497a47940aba94ef7bde82c
BLAKE2b-256 892a5aa2a9fddc43fd07611dd2512a14829eaf933ecba2611c57912f75c8c37e

See more details on using hashes here.

File details

Details for the file scine_xtb_wrapper-3.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: scine_xtb_wrapper-3.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: CPython 3.10, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.2 tqdm/4.51.0 importlib-metadata/4.8.2 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for scine_xtb_wrapper-3.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 51585c946702daaeb027a513d9246b2992f7a6246155544131b24a97130e9996
MD5 0c17c1c64ca297e88464ce02cae3a1d8
BLAKE2b-256 364d4d0eb6776ad90ba0e7f6b74a2b4729a60baa6ea8b2a7efef96a27b45bfcc

See more details on using hashes here.

File details

Details for the file scine_xtb_wrapper-3.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: scine_xtb_wrapper-3.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: CPython 3.9, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.2 tqdm/4.51.0 importlib-metadata/4.8.2 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for scine_xtb_wrapper-3.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 21e17a682ff3b3a02bd6e105d9cc87621a9d5f066a18d491534d879e5a3af9b7
MD5 1c2e1f9837bf8f5cebe5dcf64784a0ec
BLAKE2b-256 520a146b49c9deb82458babe7fee7b29437c81dcac86281117a53996d4f1e489

See more details on using hashes here.

File details

Details for the file scine_xtb_wrapper-3.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: scine_xtb_wrapper-3.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: CPython 3.8, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.2 tqdm/4.51.0 importlib-metadata/4.8.2 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for scine_xtb_wrapper-3.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4ef5f4bf21d3a97e10c836fd251eebd1167a4f30cca7fb1aa79ddb88aaffdb4f
MD5 66be75cc5d4e125540030cdafd93ef03
BLAKE2b-256 b0ac0aada0158a458e908d0eccd64e494009a8b63c55ff886dd5cb4c2f3be6af

See more details on using hashes here.

File details

Details for the file scine_xtb_wrapper-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: scine_xtb_wrapper-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: CPython 3.7m, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.2 tqdm/4.51.0 importlib-metadata/4.8.2 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for scine_xtb_wrapper-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 16c2a844f9319d948787646eed479ff454a198f905b55107db5269b845b902ea
MD5 456c01bc38da330acae73f89afcabc54
BLAKE2b-256 c5bfac73a8b5b85f7fdbedf0bb758caefd81f585ecef4029300cfcdaeb3d2221

See more details on using hashes here.

File details

Details for the file scine_xtb_wrapper-3.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: scine_xtb_wrapper-3.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: CPython 3.6m, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/28.0 requests/2.25.0 requests-toolbelt/0.9.1 urllib3/1.26.2 tqdm/4.51.0 importlib-metadata/4.8.2 keyring/21.5.0 rfc3986/1.4.0 colorama/0.4.4 CPython/3.6.8

File hashes

Hashes for scine_xtb_wrapper-3.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0205760d571a1edce194e51deb091ac8bc152b997acb91c19b6fb60795b4feaa
MD5 2170649dfd824384db83fda71ecd3a15
BLAKE2b-256 6dd671e91ffde6e993eb0e1a748ea3949fe4aab8b3be5087e50e392dc602211d

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