Skip to main content

ASE friendly implementation of the a2c workflow with MLIPs

Project description

a2c_ase

PyPI CI codecov License: MIT Python 3.10+ DOI

An ASE-friendly implementation of the amorphous-to-crystalline (a2c) workflow.

Installation

From PyPI

With uv (recommended):

uv pip install a2c-ase
Or with pip
pip install a2c-ase

From Source

With uv:

git clone https://github.com/abhijeetgangan/a2c_ase.git
cd a2c_ase
uv pip install .
Or with pip
git clone https://github.com/abhijeetgangan/a2c_ase.git
cd a2c_ase
pip install .

Usage

See example/Si64.py for basic usage.

To use a specific calculator you need to install the corresponding package.

In the example above, MACE is used as the calculator, so you need to install the corresponding package.

pip install mace-torch

Workflow Overview

  1. Initial Structure: Generate a random atomic configuration with specified composition and volume.
  2. Melt-Quench: Run MD simulation to create an amorphous structure.
  3. Subcell Extraction: Identify potential crystalline motifs within the amorphous structure.
  4. Structure Optimization: Relax subcells to find stable crystalline phases.
  5. Analysis: Characterize discovered structures using symmetry analysis.

Development

Install dev dependencies:

# with pip
pip install -e ".[dev,test]"

Set up pre-commit hooks:

pre-commit install

Run checks:

ruff check         # lint
ruff format        # format
ty check           # type check
pytest             # test

Citation

If you use this software in your research, please cite it: DOI:https://doi.org/10.5281/zenodo.17355689

References

  1. Aykol, M., Merchant, A., Batzner, S. et al. Predicting emergence of crystals from amorphous precursors with deep learning potentials. Nat Comput Sci 5, 105–111 (2025). DOI: 10.1038/s43588-024-00752-y
  2. Reference implementation: a2c-workflow

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

a2c_ase-0.0.5.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

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

a2c_ase-0.0.5-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file a2c_ase-0.0.5.tar.gz.

File metadata

  • Download URL: a2c_ase-0.0.5.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for a2c_ase-0.0.5.tar.gz
Algorithm Hash digest
SHA256 880406bfa3064fec6000c3ebe712a79142737fe7358073c66002bf996fbc2eb1
MD5 2059bc9569a69ed41ca7dc7fc7f79737
BLAKE2b-256 5e606509ffe31728faa42c84f3e78e705920d55002957bf5c3041d171c207e35

See more details on using hashes here.

File details

Details for the file a2c_ase-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: a2c_ase-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for a2c_ase-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f50ae4a665efc169818985c344de7413271f734eff6b7471025952d0919cf7ed
MD5 1dac44b03318d2e6ed7c7076e31ff0df
BLAKE2b-256 2f7dfc59a1e195eae3c692a60e9d6dc964440bf5ceda01f62a03e3f8f7eab785

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