Skip to main content

build, analyse and visualise atomistic structures for materials science

Project description

structuretoolkit

Pipeline codecov

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

Uploaded Source

Built Distribution

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

structuretoolkit-0.0.45-py3-none-any.whl (78.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: structuretoolkit-0.0.45.tar.gz
  • Upload date:
  • Size: 67.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for structuretoolkit-0.0.45.tar.gz
Algorithm Hash digest
SHA256 d9b79906c6bfc053b741c4adfc8b512ba808196c71d34b020976c39f625b8566
MD5 5134dd07c747ce69b150eef26d3d7dda
BLAKE2b-256 9ae70505b01aab25276ac9b9d23efef5c95e7b69efdd91a47c7a565582b508cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for structuretoolkit-0.0.45.tar.gz:

Publisher: deploy.yml on pyiron/structuretoolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for structuretoolkit-0.0.45-py3-none-any.whl
Algorithm Hash digest
SHA256 f689aa5c290e6127036b1013a5be2f98dde790ce924b241904c9f195876b455d
MD5 ef42626841171b00577d2227408dcff5
BLAKE2b-256 728fe1c3aa8ed1a215bf7d3db6539371e020a7f7e0a8aea6d29c885d2e6069ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for structuretoolkit-0.0.45-py3-none-any.whl:

Publisher: deploy.yml on pyiron/structuretoolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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