Skip to main content

Create atomic structures for solid solutions for molecular simulations

Project description

plats downloads Documentation Status

sqsgenerator-logo

WebAssembly icon Web Application
📝 docs


sqsgenerator is a Python package, which allows you to efficiently generate optimised Special-Quasirandom-Structures (SQS). The package uses Warren-Cowley Short-Range-Order (SRO) parameters to quantify randomness. The core routines are written in C++ and directly usable with your browser

[!TIP] sqsgenerator runs natively (multithreaded) in your browser using WebAssembly. No installation is required, just open the 🚀WebApp and start using it.

Your browser does not support the video tag.

[!IMPORTANT] Version 0.4 brings breaking changes. Most of the parameter remain the same, but some have been renamed or removed. Please refer to the documentation for more details or open an issue in case you need help migrating your scripts.

Highlights

  • 🚀 Blazingly fast short-range-order calculations (C++ core)
  • ➰ Monte-Carlo and systematic approach to compute optimal atomic configuration
  • 🧵multithreaded by default (optional MPI support) also in the browser 🌐
  • 🔀 optimize multiple sublattices simultaneously in a single run
  • 🔌 easy integration with other frameworks (ase, pymatgen and pyiron)

Installation

start directly

Start directly in your browser without any installation at 🌐 sqsgen.gehringer.tech.

You can preview the results, download single files or the entire optimization for further analysis on your local machine. The WebAssembly powered application is multithreaded and runs completely in your at near native speed.

via pip

You can install the latest release of sqsgenerator from PyPI using pip:

pip install sqsgenerator

using conda

The easiest way to install sqsgenerator is to use conda package manager. sqsgenerator is deployed on the conda-forge channel. To install use:

conda install -c conda-forge sqsgenerator

Native application (MPI)

Since version 0.4 a native application is available, which can be used in HPC environments. The application is MPI enabled and can be built from source. Please refer to the installation instructions for more details.

Cite us

In case you use the software in your research, please cite our article. Here is the BibTeX entry.

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

sqsgenerator-0.5.5-cp314-cp314-win_amd64.whl (981.0 kB view details)

Uploaded CPython 3.14Windows x86-64

sqsgenerator-0.5.5-cp314-cp314-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.34+ x86-64

sqsgenerator-0.5.5-cp314-cp314-manylinux_2_34_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.34+ ARM64

sqsgenerator-0.5.5-cp314-cp314-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.14macOS 11.0+ ARM64

sqsgenerator-0.5.5-cp313-cp313-win_amd64.whl (952.4 kB view details)

Uploaded CPython 3.13Windows x86-64

sqsgenerator-0.5.5-cp313-cp313-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.34+ x86-64

sqsgenerator-0.5.5-cp313-cp313-manylinux_2_34_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.34+ ARM64

sqsgenerator-0.5.5-cp313-cp313-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

sqsgenerator-0.5.5-cp312-cp312-win_amd64.whl (952.4 kB view details)

Uploaded CPython 3.12Windows x86-64

sqsgenerator-0.5.5-cp312-cp312-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

sqsgenerator-0.5.5-cp312-cp312-manylinux_2_34_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ ARM64

sqsgenerator-0.5.5-cp312-cp312-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

sqsgenerator-0.5.5-cp311-cp311-win_amd64.whl (948.5 kB view details)

Uploaded CPython 3.11Windows x86-64

sqsgenerator-0.5.5-cp311-cp311-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ x86-64

sqsgenerator-0.5.5-cp311-cp311-manylinux_2_34_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ ARM64

sqsgenerator-0.5.5-cp311-cp311-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

sqsgenerator-0.5.5-cp310-cp310-win_amd64.whl (947.5 kB view details)

Uploaded CPython 3.10Windows x86-64

sqsgenerator-0.5.5-cp310-cp310-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.34+ x86-64

sqsgenerator-0.5.5-cp310-cp310-manylinux_2_34_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.34+ ARM64

sqsgenerator-0.5.5-cp310-cp310-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

sqsgenerator-0.5.5-cp39-cp39-win_amd64.whl (972.5 kB view details)

Uploaded CPython 3.9Windows x86-64

sqsgenerator-0.5.5-cp39-cp39-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.34+ x86-64

sqsgenerator-0.5.5-cp39-cp39-manylinux_2_34_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.34+ ARM64

sqsgenerator-0.5.5-cp39-cp39-macosx_11_0_arm64.whl (1.2 MB view details)

Uploaded CPython 3.9macOS 11.0+ ARM64

File details

Details for the file sqsgenerator-0.5.5-cp314-cp314-win_amd64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp314-cp314-win_amd64.whl
Algorithm Hash digest
SHA256 710e151aa11e7e0678ecdd92dea72b7d83021dc8858db5779accee70807e587f
MD5 bda70fb6e1ba9928968f6d2c126af18e
BLAKE2b-256 8563d45666cfd78110880cac942bc2a267f56c3de3af462dc157bbc2e22f64ba

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp314-cp314-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp314-cp314-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 a92c6daf12db6090dd39418de976aa6e8c1de0dd108634e18e69cc5ede26736c
MD5 cab6b3004cbe37efa6edd1b2f82c7e84
BLAKE2b-256 55854cb3204fbc3d20a6007c73a6e65222405f7bb9eebc6ee62c2fa8b5c68446

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp314-cp314-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp314-cp314-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 00ee84ea542a4208f3c7af774565e86f6fb3ca307ee15a31b8d3fd9f1a3762bd
MD5 013ae4f3d6dd339e6f513c0396d04bf8
BLAKE2b-256 3cbaa5c84467f236a41e297d77d9e332c4a4d62c8cee0c23d083459028250669

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp314-cp314-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp314-cp314-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d6eb3050ecdc3d2e45c79d1a0fd6b6f56deba8378d6f0c7571a94de0d5de8947
MD5 a73dc408d00cf346c939f7f028dd8dd9
BLAKE2b-256 5e24a5443a11f73b693bc4f479f0d44c2b5801ba9e0ac61d3b9590b647cbb252

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 32e8536217c5b59c92367dafa61d0a388be4759bb5fd1079f2600667c4ef71d7
MD5 19905d5214fc7655f12c5f05e2754ea2
BLAKE2b-256 2accda17897df9a5d4616016f9fcbface423324fe2ec9bad9aed08c9849f13a9

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp313-cp313-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp313-cp313-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 ef0ece75ec832d73b5ba1dcf5662422fbe1f5f0fee54dcaca8a4d132d1305b19
MD5 e59e701bc638cff9dde490e3f2ecb08e
BLAKE2b-256 767cca729df21f74aef6c22a27773bb9051c1a9dd0dda122e823c6a28b303cc1

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp313-cp313-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp313-cp313-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 5dfa1b0990c974e99839e741c0fc41c2a38f26a24da1a77044578e6714b555da
MD5 c37d2805621dd6b00a992511048a1979
BLAKE2b-256 764917efdba29edb6ea063cf003160e5ef0ca6b438d4c48fcb288720d7e28474

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 55b808eb03e5a5d53b700638f09b54a333d89ad76c5fd4c7a30f338e2628c991
MD5 f9c4f04a705ba1174ee2e53b5f5e20b7
BLAKE2b-256 813b9e74cc1616427342edc0707b5bfd88a281a6c5cc0a35db2201243f544ccf

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 a1274ad72978bbaa2b3899daedbde094523fb403dcba59d6c876da87ce62029d
MD5 372ef2ba91942b3ba8e7f35718163d06
BLAKE2b-256 5861a68978d99a243fb6b0aa8aa91bc9a25200f663bf4e96858e3e5694533471

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 c17355d7ae20d72f392bcf6da2a561422228c4cba3af451c8633af87e356bc96
MD5 f6c83dc2938b1503f1c2e15cc2569b14
BLAKE2b-256 a8793e24f2fd743c0794a3ddb1d67b5265669c5a8b3f5256f853d7c38a5dbfb3

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp312-cp312-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp312-cp312-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 2087ac34f8667b0b5b4c94bc1dcfae0a89d614e97bcb110e0fec52424653a01a
MD5 a7f05de370c2b69e26a1b7210494753f
BLAKE2b-256 bd7913b3ff4c780d478769e9864b6d7d9c104226f474ac9a485c04f3963f3c9f

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 af36a1cb4a377b81b1b23e9936f5400bce4b0dcc6324fb3fe9c111348f983823
MD5 8aa6e1a00a5b9751b915e2439fba3e77
BLAKE2b-256 f693d7b5959efb7f97b9b7e6d26dd2fc8d516d1aac4c3f476e68403e594ea9f4

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 52784420afb1c6de0debf89a95338ec3aad90dc819aa7e766ead266db8cf9c6c
MD5 5cbe60e4c7c8f994f87eff8e9c257746
BLAKE2b-256 e666310ec2cd3ff46ac6605882a237767c399a3cf50d063e88a2ea13d9183390

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp311-cp311-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp311-cp311-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 4d17bdc66a6631c9a09a5d302251e4a84a49bc9edc2f29ecde58e5d2000a225a
MD5 b252d259238f7aaa5f250e61a9096447
BLAKE2b-256 8c1b4f709350248495ff420ab53b3b7f1e9ebc04335a91d4552fbd449e26d98f

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp311-cp311-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp311-cp311-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 29809a17cf4c8a84bcb12b36f859ba6d0d32e0951197212b42361e0242f0aef3
MD5 2db9ae1314b856c0ef50dab497177070
BLAKE2b-256 814219e09e3e411eeb1a5070d09164d217f3d4de7f2cc1c6ca2d73e40624a670

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0b6b9143cb39428f843d3c5c4fa4b9db3c06e2bbd10c69203d60ec5e517cf58e
MD5 78d3c3ec9a0fc4c004b48efa7c7eb1b7
BLAKE2b-256 5351ec737a0b84d8e8b7c822022cc5ab5c7cebe01d099aa0d3eb7dcb68ad6f70

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 2b39775dc7d4ffd00ed890d1470c320d4b92dd5feddfc52ab58e326c6397c479
MD5 042f9465c23405f0e18febd7cb3607ac
BLAKE2b-256 851308d2e303892b2fbbb4cb178acd51ba360242d151e9181c8cf0f149029639

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp310-cp310-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp310-cp310-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 1e0e2e79297f74bd7b1d1a61f4fb22e824ef126fa1d83fc49c797dc79ddaa842
MD5 1511512e046978436309eeb04c63a450
BLAKE2b-256 813f15cdf54652878825b7b732e7d09400232a9a2904ca9bd7945c4362b2c171

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp310-cp310-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp310-cp310-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 8a8478793ae9aee7ffcf9c1c486ffa4c807d59fa324a21be14d71b6f44019a71
MD5 da2d81eed4a8f9bfb1e6a758c80b3b60
BLAKE2b-256 c804e99287c3f3f319a2e90992b4edd633a5ab130599bbc6feafaa0e82d9066f

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2f836942a33b77735404522c76801ab8dde064de1555bc664bb61b09becb4c49
MD5 1d88485176f53b929de2146ef4f932e3
BLAKE2b-256 e7306805f33f3fd5c318ada206b33af1a5cfa0f0098ea6a5219e278f7f42b27b

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: sqsgenerator-0.5.5-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 972.5 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sqsgenerator-0.5.5-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 ed87db9e62ce3fbd3946dcbd92f69de29bd4f0a9b37550b3c3687c720ee281a7
MD5 a7e43ca55f98297617e197fdd453245e
BLAKE2b-256 f4214fbbf8fbf7a592bbbc6ca96e844f0e94913c8e3d7d3f21fd4805f9f82045

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp39-cp39-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp39-cp39-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 1da5217ce5880cb195c6813560106365e45ed940eeb2d1738653e931c9f2a38f
MD5 09fa6177eee97dd59532630c4915b78d
BLAKE2b-256 b7487d25fcd8e04d4ef6441aee75f65967cf4f3db76edd74f2a46f9b90d3df62

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp39-cp39-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp39-cp39-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 0c298fca0b1e612479894b9c1b212d8c6fd126d6c9314b77e78ca1f8be7f1824
MD5 582391ef0deb857982fe6da2b2c00537
BLAKE2b-256 812249de9ce388895f58b956e5a9b89e5182e00407796d6199b770d6b1eee65f

See more details on using hashes here.

File details

Details for the file sqsgenerator-0.5.5-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sqsgenerator-0.5.5-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c49ba01746585dc2aa0ccbea5d23461c8b3027fb381cecf169bf7f024ef803f8
MD5 e34b262adad97db2c507fdfd5e17f481
BLAKE2b-256 2301412aef7488484f8b6712ed6c3d930f38fae133ec3a918beab3249930d5ae

See more details on using hashes here.

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