Skip to main content

No project description provided

Project description

Fast calculation of structural parameters and autocorrelation functions

fastatomstruct is a Python package written in Rust that includes functions to calculate atomic structural quantities. If possible, thread-based parallelization (using rayon) is employed to speed up calculations and take advantage of multicore processors.

What can this package do?

The package can currently calculate the following quantities:

  • Structural
    • Angular-limited three-body correlation (ALTBC)
    • Bond length ratio (BLR)
    • Atomic distances
    • Coordination numbers
    • Nearest neighbours
    • Bond orientational parameter (Steinhardt et al.) and Bond Order Correlation parameter
    • Tetrahedral order parameter
  • Dynamical
    • Autocorrelation (with and without interpolation)

Installation

From PyPI

fastatomstruct can be installed from the Python Package Index. Currently, only Linux with a Python version >= 3.7 is supported. In addition, your processor has to be x86-64 with AVX2 support. Most all processors since 2015 should meet those criteria. If your system doesn't, you can still install fastatomstruct from source (see next subsection).

To run the installation, use

pip install fastatomstruct

From source

Installing fastatomstruct from source requires

  • Python 3
  • pip
  • a working Rust installation (1.56 and newer), including cargo
  • maturin, a Python package that can e.g. be installed using pip3 install --upgrade maturin

To build the Python wheel, run

maturin build --no-sdist --release

The resulting wheel will be located in target/wheels/. You can install it using

python3 -m pip install target/wheels/fastatomstruct-version.whl

Replace "version" with your actual Python version. The package can then be used in Python using e.g. from fastatomstruct import coordination_numbers.

Documentation

The documentation can be found here.

Example usage

This example uses the Atomistic Simulation Environment, which can also be installed using pip (pip install ase).

from ase.build import bulk
from fastatomstruct import distances, coordination_numbers

# Lithium in the BCC phase with the unit cell repeated
# 10x10x10 times
atoms = bulk("Li", "bcc", 3.45).repeat((10, 10, 10))

# Atomic distances
dists = distances(atoms)

# Coordination numbers with a cutoff of 3 A
coordination = coordination_numbers(atoms, 3)

Optimizing your installation for performance

Consider using

RUSTFLAGS="-C target-cpu=native" maturin build --no-sdist --release

to optimize the binary for your local processor. As a downside, this will make the resulting Python wheel less portable.

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

fastatomstruct-0.4.0-cp310-cp310-manylinux_2_28_x86_64.whl (295.9 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.28+ x86-64

fastatomstruct-0.4.0-cp39-cp39-manylinux_2_28_x86_64.whl (295.9 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.28+ x86-64

fastatomstruct-0.4.0-cp38-cp38-manylinux_2_28_x86_64.whl (295.9 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.28+ x86-64

fastatomstruct-0.4.0-cp37-cp37m-manylinux_2_28_x86_64.whl (295.9 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.28+ 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