Skip to main content

Compute orientation order parameters 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,
    parallel=True,
)

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

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.0.tar.gz (10.2 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.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orivec-0.1.0.tar.gz
  • Upload date:
  • Size: 10.2 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.0.tar.gz
Algorithm Hash digest
SHA256 f2b54add5c6c89081b0280764747f0ea43ebe84958e12074481af3c0d52b0b8f
MD5 10ce761cf0a912e98539be87e617517d
BLAKE2b-256 cb970d081fd9a69041f366a980d886ceec9b4f548c48072bc3f9a362df08aa24

See more details on using hashes here.

File details

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

File metadata

  • Download URL: orivec-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ef1705b885200c6252cc2fdc589c0f24c13e7c3a82d71079cea98867be1d3a1
MD5 24e6ad48e111cd65876635bb2c76a514
BLAKE2b-256 a7a35a2f89ebb761b03e4c6f3436ac8bd04e4bdff907994bb029cc63c555e166

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