Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 label its output structures with reference energies and forces on your own, either with an ASE calculator or by any other method. 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}
}

Download files

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

Source Distribution

assyst-1.0.0rc2.tar.gz (1.3 MB view details)

Uploaded Source

File details

Details for the file assyst-1.0.0rc2.tar.gz.

File metadata

  • Download URL: assyst-1.0.0rc2.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for assyst-1.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 04b6ace5bfa6750482055eda6cdfc9034aed054f88630c9bcc90a2f77189769b
MD5 0ad49b2dfb81122d1c79046e21a5ae5c
BLAKE2b-256 a946bba3fd66ebea628248301b4630709b8aa68e056d3897b9b541a23fcd262a

See more details on using hashes here.

Provenance

The following attestation bundles were made for assyst-1.0.0rc2.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