Pre-release
This release is a pre-release and may not be stable for production use.
SolidKit: A Modern Toolkit for Solid-State Physics
SolidKit is an easy-to-use Python package designed to streamline common tasks in solid-state physics and materials science. It provides a convenient command-line interface for generating complex structures like grain boundaries and polycrystals, as well as calculating material properties such as hardness.
Installation
You can install SolidKit directly from the Python Package Index (PyPI).
Stable Version
To install the latest stable release, use pip:
python -m pip install solidkit
Development Version
For the latest features and updates, you can install the pre-release version:
python -m pip install --pre solidkit
Command-Line Autocompletion (Optional)
SolidKit supports command-line autocompletion to help you discover and use its features more efficiently. This is provided by the argcomplete package.
1. Install argcomplete
First, ensure you have argcomplete installed:
python -m pip install argcomplete
2. Activate Autocompletion
Run the following command in your terminal, and restart your shell. This is a one-time setup that enables completion for all supported Python applications.
activate-global-python-argcomplete
Once activated, you can type python -m solidkit followed by a space and press the Tab key to see a list of available commands and options.
How to Use
SolidKit can be used directly from your terminal. The general syntax is:
python -m solidkit [COMMAND] [OPTIONS]
Example:
- Generate a twin boundary.
python -m solidkit boundary -f diamond.cif --plane 1 1 1 -o output.vasp
- Estimate the Vickers hardness.
python -m solidkit hardness -f diamond.cif --method simunek
1 maintainer
Metadata
1 maintainer
Release files for solidkit 1.0.0.dev40
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 52.2 MB
Release files / solidkit-1.0.0.dev40-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.7 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
3c3e63a0c7a4be49e3c781bf12b6bcd8bc4fff3347bdafbfe2095fd25595199c
|
|
BLAKE2b-256 checksum How to use checksums |
f5795ea9b65daa45a676add64b621418094477ec7bf52a7755178a0cafe716d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | solidkit-1.0.0.dev40-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-32 Linux glibc 2.5+ x86-32 |
|
SHA-256 checksum How to use checksums |
e26c22ff30062d88a53d1ed7ab3966049c568a7803cd59c39399d276d77d4846
|
|
BLAKE2b-256 checksum How to use checksums |
e43963aea38ec475b2dc287e8bc252cdae0435ca800f90378e322b86b2916347
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | solidkit-1.0.0.dev40-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 769.0 kB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
5e1051449f787a96845c6d7b4361d424a042fb94535b738a2616d60ba0090dbd
|
|
BLAKE2b-256 checksum How to use checksums |
0ecbe1b8cdfbd42aea4d8e287264241a8ce5c63c34582d3606f24a8beed50a94
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp313-cp313-macosx_10_13_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp313-cp313-macosx_10_13_x86_64.whl |
|---|---|
| Size | 756.6 kB |
| Tags | CPython 3.13 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
5a66c1d650b92f2648bd6ccf3d7ef3df9a499bc8d9a7ad6c74af191f5adef625
|
|
BLAKE2b-256 checksum How to use checksums |
3214e5662040c00f6a831bc4a821c4f3300c77001ac3df5452adce51d82b8d8a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.8 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
fbd9cfa72c8598b9b0cdf6230e01192ac62f3b5ebb0ac8da9be1fbfe21b411b4
|
|
BLAKE2b-256 checksum How to use checksums |
f718085242d1b635cdfa62f1c6a6610d5e3e4803cfc54748dff3306fc5c36e22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | solidkit-1.0.0.dev40-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-32 Linux glibc 2.5+ x86-32 |
|
SHA-256 checksum How to use checksums |
e3a8fe0afbbe5c7d53309a68e4412c80079eeb055572a77f6bc32a0065a2042e
|
|
BLAKE2b-256 checksum How to use checksums |
6d5171be3e146381799a263b37ad2e02aeb44712ee8ab01933ea1ada9150f7ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | solidkit-1.0.0.dev40-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 779.7 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
22ec80e0ca3ae8085f9675e5fceb05328539ed28894d7ba2b95547f1db7bf4e6
|
|
BLAKE2b-256 checksum How to use checksums |
59798431d483cb9fcc7070b729cb88a5019af0f262a0f8e89ad6f2966fafd1a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp312-cp312-macosx_10_13_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp312-cp312-macosx_10_13_x86_64.whl |
|---|---|
| Size | 768.2 kB |
| Tags | CPython 3.12 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
a3178df33cef0b125218021e8f337307b7dc2379827702e7fec053fb507f01c0
|
|
BLAKE2b-256 checksum How to use checksums |
bf46c997391d1604577bf475377a17ac7867d306b5b5295688ff48e85507ac1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.6 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
7de9a19fb4619a6a149590fa05759d946b02c1d479840499e7d99c5c714145d3
|
|
BLAKE2b-256 checksum How to use checksums |
6c61fb9230c2127179ced9acc649720e6deedce1479894e8b37fb1003c13e235
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | solidkit-1.0.0.dev40-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-32 Linux glibc 2.5+ x86-32 |
|
SHA-256 checksum How to use checksums |
944a5c1f7f35a8421521a80b74d03892ccbbc72ed5ea4e51128312e539c00ddf
|
|
BLAKE2b-256 checksum How to use checksums |
1c25346988c9e838126fea8896293ee4296834bf1fc5a453de2f5fbf93cd873d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | solidkit-1.0.0.dev40-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 778.4 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
bcd30545d8f93c6b2668e06ea1e9bd4afd03f0094d6e4f939af0cb960323fb7a
|
|
BLAKE2b-256 checksum How to use checksums |
33540c1e1fbe9e0c91ee53a7fcebb0e891eafcb9c13dc2bd1d35f8080c58d629
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp311-cp311-macosx_10_9_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp311-cp311-macosx_10_9_x86_64.whl |
|---|---|
| Size | 779.7 kB |
| Tags | CPython 3.11 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
2ae156f20048e34e6e8db41323706572872a03f76b8aa0dfd001e514f0229590
|
|
BLAKE2b-256 checksum How to use checksums |
7b00dcf9b93444dc5d2121f3957fa3a6142202712a6ea4580d2ad76973a31cee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.3 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
8a355c07d0a809a02a0a184d4a206a85e858ccb37ed93179642b8c66c7c81d90
|
|
BLAKE2b-256 checksum How to use checksums |
f88a10747f47403316af4b94da37ffbc357e5f3c58aba08b49aa492c9a18b0f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | solidkit-1.0.0.dev40-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 4.2 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-32 Linux glibc 2.5+ x86-32 |
|
SHA-256 checksum How to use checksums |
f4bc026bffcb6e5aef0cbe3184afe56912ffb37dd735ea09f301078b91ea054c
|
|
BLAKE2b-256 checksum How to use checksums |
c080ad26aaf013d77339ac3a49116e326d2ba7aa48bf8af7fc715fab1eb1fd77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | solidkit-1.0.0.dev40-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 768.0 kB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
c24df22c0c475bc41d6e1f1a3c6d178ae300f347b4991496bcd6d02f98ecb306
|
|
BLAKE2b-256 checksum How to use checksums |
ef5b71957b2edb534b135a040a193b15dee04bc6e69ce0628bde86b137b4c9f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp310-cp310-macosx_10_9_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp310-cp310-macosx_10_9_x86_64.whl |
|---|---|
| Size | 769.7 kB |
| Tags | CPython 3.10 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
d757c91b0f575ecd564f66aead0f513a156675150fc491a75b3ca0ffe17aa81a
|
|
BLAKE2b-256 checksum How to use checksums |
a1686f64cd67460b0e80892fed375b9b8ccedd22508d69f583c071b823669049
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.3 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
60645e4e812393652893140b9e56bc2c6ca1a473ee48b05bf3a20b104fbaf417
|
|
BLAKE2b-256 checksum How to use checksums |
5ac9e16a549d0897b7db4aa06789301e8c975876b9dd61a7ff7a3f00eeb19945
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | solidkit-1.0.0.dev40-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 4.2 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-32 Linux glibc 2.5+ x86-32 |
|
SHA-256 checksum How to use checksums |
2f34d1d1123eb2b96f0f6d33a19aa0fd028be40c5a611b1a95888ff876fbc845
|
|
BLAKE2b-256 checksum How to use checksums |
243cb30bbb0eb3a9b96ad179b94f55b91007830485bc8d4a772560509151b467
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp39-cp39-macosx_11_0_arm64.whl
| Download URL | solidkit-1.0.0.dev40-cp39-cp39-macosx_11_0_arm64.whl |
|---|---|
| Size | 772.1 kB |
| Tags | CPython 3.9 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
817dc7d9e28ae4580e3856fae51159d455a89a7128fd0040bb152175e375893a
|
|
BLAKE2b-256 checksum How to use checksums |
040d7bc0feb67e9b4a48b3a1cc8ca208d4f8ecb7f8c7c7033cc7400ddb5347a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / solidkit-1.0.0.dev40-cp39-cp39-macosx_10_9_x86_64.whl
| Download URL | solidkit-1.0.0.dev40-cp39-cp39-macosx_10_9_x86_64.whl |
|---|---|
| Size | 773.2 kB |
| Tags | CPython 3.9 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
1f217082f2570ed5b285fb8b6adbd95e86b8c8f534598c68d8c01c74f8d42323
|
|
BLAKE2b-256 checksum How to use checksums |
8613175ae38f1daa3a61eea69202016c852478823eb1032999e719c6e743336e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
