Skip to main content

Reference implentation of the Automated Small Symmetric Structure Training method.

Project description

DOI Documentation Status codecov

ASSYST or Automated Small SYmmetric Structure Training

A flexible reference implementation of the ASSYST method to generate transferable training data for machine learning potentials.

ASSYST is the Automated Small Symmetric Structure Training, a training protocol, aimed at providing comprehensive, transferable training sets for machine learning interatomic potentials (MLIP) automatically. A detailed explanation and verification of the method can be found in our papers. 12 ASSYST gives up the notion of fitting potentials to individual phases or structures and instead tries to deliver a training set spanning the full potential energy surface (PES) of a material.

This software package is a minimal implementation of this idea, designed to be as flexible as possible without assuming either a specific MLIP, reference data, or workflow manager in mind. It is built on ASE and can use any of its calculators. It also assumes that you bring your own reference energies and forces. For a ready-to-run implementation that targets Atomic Cluster Expansion and Moment Tensor Potentials fit to Density Functional Theory (DFT) data check out pyiron_potentialfit.

ASSYST schema

Citation

Please use the following citation when referencing the method in your work.

@article{poul2025automated,
  title={Automated generation of structure datasets for machine learning potentials and alloys},
  volume={11},
  DOI={10.1038/s41524-025-01669-4},
  number={1},
  journal={npj Computational Materials},
  author={Poul, Marvin and Huber, Liam and Neugebauer, J\"org},
  year={2025},
  month={Jun}
}

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

assyst-0.14.1.tar.gz (941.5 kB view details)

Uploaded Source

File details

Details for the file assyst-0.14.1.tar.gz.

File metadata

  • Download URL: assyst-0.14.1.tar.gz
  • Upload date:
  • Size: 941.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for assyst-0.14.1.tar.gz
Algorithm Hash digest
SHA256 4e2955522bc436c11e324bfb0f7ccf1ef15853c52edced5a1b3bb7716d1ee96b
MD5 a1338a9acf08a197d11a7e97393f9300
BLAKE2b-256 5280b02e9a6ff62a85add2f296b129cb3d5917a500faff7adbd5eae1dd1b35c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for assyst-0.14.1.tar.gz:

Publisher: pypi-publish.yml on eisenforschung/assyst

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