Skip to main content

Compute orientation order parameters in polycrystals with point cloud ICP method.

Project description

OriVec

OriVec provides tools to compute orientation order parameters for local motifs in atomistic point clouds.

Installation

pip install .

Command Line Usage

orivec .\liquid.data .\ref_unit.xyz --element-map 1=Li,2=Mo,3=S --selected-element S --regularize --parallel --output liquid-orientations.xyz

This command reads a LAMMPS data file, aligns local motifs to the reference geometry, stores the resulting orientation vectors in per-atom arrays, and writes the augmented structure to liquid-orientations.xyz.

Python API

from orivec import get_order_parameters
import numpy as np

structure = get_order_parameters(
    "liquid.data",
    "ref_unit.xyz",
    ref_orientation=np.array([0.0, 0.0, 1.0]),
    elements={1: "Li", 2: "Mo", 3: "S"},
    selected_elements=["S"],
    regularize_orientations=True,
    regularize_anchors=np.array([0.0, 0.0, 1.0]),
    parallel=True,
    max_workers=8,
)

The resulting ase.Atoms object stores orientation vectors in structure.arrays['orientation'], structure.arrays['inlier_rmse']

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

orivec-0.1.1.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orivec-0.1.1-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file orivec-0.1.1.tar.gz.

File metadata

  • Download URL: orivec-0.1.1.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for orivec-0.1.1.tar.gz
Algorithm Hash digest
SHA256 33deb1cdcfd2418407c5578f479d219b832e31552678ed628596d74e509c5b0f
MD5 38c8c04e9b6a4a5411e5879a6ba075be
BLAKE2b-256 43ddd6f4adb873e0485f4aa443ef67267da6593de6c6c30bf3345650b646b875

See more details on using hashes here.

File details

Details for the file orivec-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: orivec-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for orivec-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6d853690b2a232463c599e4975e841882ac47fabf5ae1ee619f1efb3709fe42a
MD5 eec4222c7621c17b04974d1b6e4742ae
BLAKE2b-256 82200a5ed10ba29bff795adcd19c65f1a4bcb5c4c63a6e36db26b85c93195b52

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page