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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for structuretoolkit-0.0.16.tar.gz
Algorithm Hash digest
SHA256 cbafa48a8c3a8ea224b5e59203d2430148737efd924bca6a92644a246b4dc81d
MD5 18b21e80f31587e53ab4963e37ca6392
BLAKE2b-256 0e5a636e467f7fe53474b8aedd847fcbb78aa8497e8a683cd3f28c0837f2b16a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for structuretoolkit-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 3859531df6484b5f284c69bf3d0cdf6120d7c3d1e9927d357bbb650b822d3bba
MD5 0073b2a29352af071857040d506907c4
BLAKE2b-256 145f348ce46d7bc7af0c81c66fcc1e8799f7b86e4f987578e6a7f15f992244c3

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