Skip to main content

build, analyse and visualise atomistic structures for materials science

Project description

structuretoolkit

Unittests Coverage Status

Originally developed as part of the pyiron_atomistics module the structuretoolkit was release as standalone library for analysing, building and visualising atomistic structures. Internally it uses the ase.atoms.Atoms class to represent atomistic structures in python. The structuretoolkit is integrated inside pyiron_atomistics.

Disclaimer

The structuretoolkit is currently under development.

Example

import structuretoolkit as stk
from ase.build import bulk

structure = bulk("Al", cubic=True)
stk.analyse.get_adaptive_cna_descriptors(structure)
stk.plot3d(structure)

Features

Analysis

  • stk.analyse.get_neighbors()
  • stk.analyse.get_neighborhood()
  • stk.analyse.get_equivalent_atoms()
  • stk.analyse.get_steinhardt_parameters()
  • stk.analyse.get_centro_symmetry_descriptors()
  • stk.analyse.get_diamond_structure_descriptors()
  • stk.analyse.get_adaptive_cna_descriptors()
  • stk.analyse.get_voronoi_volumes()
  • stk.analyse.find_solids()
  • stk.analyse.get_mean_positions()
  • stk.analyse.get_average_of_unique_labels()
  • stk.analyse.get_interstitials()
  • stk.analyse.get_layers()
  • stk.analyse.get_voronoi_vertices()
  • stk.analyse.get_voronoi_neighbors()
  • stk.analyse.get_delaunay_neighbors()
  • stk.analyse.get_cluster_positions()
  • stk.analyse.get_strain()

Build

  • stk.build.get_grainboundary_info()
  • stk.build.grainboundary()
  • stk.build.high_index_surface()
  • stk.build.get_high_index_surface_info()
  • stk.build.sqs_structures()
  • stk.build.pyxtal()
  • stk.build.B2()
  • stk.build.C14()
  • stk.build.C15()
  • stk.build.C36()
  • stk.build.D03()

Visualize

  • stk.visualize.plot3d()

Common

  • stk.common.ase_to_pymatgen()
  • stk.common.pymatgen_to_ase()
  • stk.common.pymatgen_read_from_file()
  • stk.common.ase_to_pyscal()
  • stk.common.apply_strain()
  • stk.common.center_coordinates_in_unit_cell()
  • stk.common.get_extended_positions()
  • stk.common.get_vertical_length()
  • stk.common.get_wrapped_coordinates()
  • stk.common.select_index()

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

structuretoolkit-0.0.15.tar.gz (65.6 kB view details)

Uploaded Source

Built Distribution

structuretoolkit-0.0.15-py3-none-any.whl (64.1 kB view details)

Uploaded Python 3

File details

Details for the file structuretoolkit-0.0.15.tar.gz.

File metadata

  • Download URL: structuretoolkit-0.0.15.tar.gz
  • Upload date:
  • Size: 65.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for structuretoolkit-0.0.15.tar.gz
Algorithm Hash digest
SHA256 1a258a072055d0c20e9d56156afd4481cfc94c2612c1b908de4b274b423cc6e6
MD5 949c0c1017a08ea88bb530fc81f08ac6
BLAKE2b-256 e5b15ceb3e4177c585354d2e5fd2a709bbbb796cb2fcae1955b9965ea786ba54

See more details on using hashes here.

File details

Details for the file structuretoolkit-0.0.15-py3-none-any.whl.

File metadata

File hashes

Hashes for structuretoolkit-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 26995e5ae7047ab25c19684aa794e8a5182f45ba6a1d5a7ac1027baa70f2b235
MD5 09212d0b67382672cacd48d0c83392f1
BLAKE2b-256 5b8c80d5e99f1136ff84c75f37cac758ffd28463ed7b1504b4832757f89e1329

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