Skip to main content

Tools for the pace-mdgroup project.

Project description

Precise and Accurate Configuration Evaluation


Python 3.10+ Static Badge MIT License

The workbook contains the code and notebook to run PACE (Precise and Accurate Configuration Evaluation).

PACE identifies stable ground-state base–adsorbate configurations through a multistep approach. It begins by performing single-point MLIP calculations on adsorbates placed at predefined grid points within the unit cell, where grid resolution (number of subdivisions along each axis) controls the density of possible adsorption sites.

After ranking the resulting configurations based on single-point MLIP energy predictions, the most promising candidates undergo MLIP structure optimization, followed by first-principles DFT optimization of the MLIP-predicted ground state.

🚀 Environment Setup

  • System requirements: The package is designed to run on a standard Linux system equipped with a GPU that supports CUDA version 10 or higher and at least 2 GB of RAM. It has been tested on NVIDIA V100 SXM2. For GPUs with CUDA versions below 10, you will need to adjust the PyTorch and CUDA versions specified in the environment.yml file

  • We’ll use conda to manage dependencies and configure the environment on an NVIDIA GPU-enabled system.

  • It’s recommended to install Miniconda using the official installer.

  • Once conda is installed, add mamba to your base environment for faster and more reliable package management.

    conda install mamba -n base -c conda-forge
    
  • Then create a conda environment and install the dependencies:

    mamba env create -f environment.yml
    

    Activate the conda environment with conda activate pace-env.

  • Alternative:

    mamba env create -n pace-env
    

    Install from the requirements.txt file

    pip install -r requirements.txt
    

⚙️ Installation

pip install pace

if PyPI installation fails or you need the latest main branch commits, you can install from source:

pip install git+https://github.com/dixitmudit/PACE.git

🧪 Getting Started

1. Direct Usage

After placing the VASP files of the base and adsorbate in the current working directory, the main.py file can be executed as follows:

  python main.py --model /path/to/your/mace/model.model --metals Fe-Ru Fe-Mo --adsorbates Li2S Li2S2 --device cuda

2. Example notebook

The following is an example workflow to carry out experiments with the PACE algorithm.

Open In Colab

3. PACE class implementation

You can directly import PACE into your current workflow assuming you are using ase and MLIPs

from pace import PACE
from ase.io import read, write
from mace.calculators import MACECalculator

mace_calc = MACECalculator('/path/to/model/here')
base = read('/path/to/base.vasp')
adsorbate = read('/path/to/base.vasp')


# Setup PACE:
pace = PACE(base=base, adsorbate=adsorbate, division=5, z_levels=[1.35, 1.75]) # z_levels: distance of adsorbate from base in Angstroms

# Screen conformations
results = pace.screen(calculator=mace_calc, fig_save_at='/your/path/here', mlip_optimization=3)
# if mlip_optimization > 0, it will initate mlip optimization of top `input: integer` (by_default: 20) structures.

optmised_structure = results['screened_structures'][0]

🌈 Acknowledgements

M.D. and S.K. gratefully acknowledge the financial support provided by the CSIR, India, which facilitated the completion of this work. A.M.K.R. acknowledges the Department of Atomic Energy and UM-DAE-Centre for Excellence in Basic Sciences,

We express our gratitude to the National Supercomputing Mission (NSM) for granting access to the computing resources of the Param Porul HPC System. This system is implemented by C-DAC and is supported by the Ministry of Electronics and Information Technology (MeitY) and the Department of Science and Technology (DST), Government of India.

This code repo is based on several existing repositories and MLIPs:

📝 Citation

If you find our work useful, please consider citing it:

@misc{https://doi.org/10.48550/arxiv.2510.15397,
  doi = {10.48550/ARXIV.2510.15397},
  url = {https://arxiv.org/abs/2510.15397},
  author = {Kumar,  Sahil and R,  Adithya Maurya K and Dixit,  Mudit},
  keywords = {Materials Science (cond-mat.mtrl-sci),  FOS: Physical sciences,  FOS: Physical sciences},
  title = {Unravelling the Catalytic Activity of Dual-Metal Doped N6-Graphene for Sulfur Reduction via Machine Learning-Accelerated First-Principles Calculations},
  publisher = {arXiv},
  year = {2025},
  copyright = {Creative Commons Attribution 4.0 International}
}

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

pace_mdgroup-0.1.0.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

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

pace_mdgroup-0.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file pace_mdgroup-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for pace_mdgroup-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5ed4b2169bafc1add2c69b34bca4d2d65efffc8fb61bcee06816dd00de292f48
MD5 ce82296162f4162c17ec00f270d7c5bf
BLAKE2b-256 8bece54170e36b3544577f31c01fba0315fd26dd5de8a73956b9df904a3871a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pace_mdgroup-0.1.0.tar.gz:

Publisher: python-publish.yml on dixitmudit/PACE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pace_mdgroup-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pace_mdgroup-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pace_mdgroup-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23f53f430d3f636bf8bb528cad137f5be02bb9de31baebd23968316cd84e6220
MD5 343143dbc87a48fb4f34448c479121d7
BLAKE2b-256 762b47e02962aa598855ee29ea557f88496da669657c22fe18a1d6023f41ba46

See more details on using hashes here.

Provenance

The following attestation bundles were made for pace_mdgroup-0.1.0-py3-none-any.whl:

Publisher: python-publish.yml on dixitmudit/PACE

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