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+

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](https://github.com/abhijeetgangan/a2c_ase/blob/main/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

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.2.tar.gz (21.2 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.2-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: a2c_ase-0.0.2.tar.gz
  • Upload date:
  • Size: 21.2 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.2.tar.gz
Algorithm Hash digest
SHA256 68fe2c09ff0758d3f67f41e470950e12158dcc326d7e4a4a3e8cc3b82eb96771
MD5 070f4212f5bad5605cf066af7aa216ea
BLAKE2b-256 238a50519109e854626ec60f57ce874a3e0f72219a9630c3b1b1cff1a5651629

See more details on using hashes here.

File details

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

File metadata

  • Download URL: a2c_ase-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 20.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 562e915f20ab20290cdcea2060c4594ed54839a575d5d34f979eef31627faf12
MD5 067bd2b2f50bf6073f3dcfa2c9dd0e17
BLAKE2b-256 c3a3ec0f4840194411161820b79414af28e1cf1008decda63e23015a892a7637

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