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.24.tar.gz (79.7 kB view details)

Uploaded Source

Built Distribution

structuretoolkit-0.0.24-py3-none-any.whl (73.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: structuretoolkit-0.0.24.tar.gz
  • Upload date:
  • Size: 79.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for structuretoolkit-0.0.24.tar.gz
Algorithm Hash digest
SHA256 c06924d926a597b7c76c3704e1127a9003e0f021131a70c7bc2b2f0ab25d7cee
MD5 4f9d78aad797f4426f9582eef24cdfe3
BLAKE2b-256 a1efd25adcdb7aa5b81f9ccb0a12afce8f1c16c838e8cb5f5142f590892d841b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for structuretoolkit-0.0.24-py3-none-any.whl
Algorithm Hash digest
SHA256 0c69c6b2e28ff124ac11cbc0b5617bc7e55c2b920aa826d87931be77edd4cc06
MD5 6d9a841aca89512db952083adf0bee51
BLAKE2b-256 9810e87c6b07eb2884a8b15eeb1c30ef01e0e20608a9de59d914f5cb728bb93f

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