core.components.calculate.adsorbml_runner

core.components.calculate.adsorbml_runner#

Copyright (c) Meta Platforms, Inc. and affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Classes#

AdsorbMLRunner

Run the AdsorbML pipeline to identify the global minima adsorption energy.

Module Contents#

class core.components.calculate.adsorbml_runner.AdsorbMLRunner(calculator: ase.calculators.calculator.Calculator, input_data_path: str, place_on_relaxed_slab: bool = False, save_relaxed_atoms: bool = True, adsorption_energy_model: bool = False, num_placements: int = 100, optimizer_cls: type[ase.optimize.Optimizer] = LBFGS, fmax: float = 0.02, steps: int = 300)#

Bases: fairchem.core.components.calculate.CalculateRunner

Run the AdsorbML pipeline to identify the global minima adsorption energy. The option to also relax a clean surface is also provided.

This class handles the relaxation of atomic structures using a specified calculator, processes the input data in chunks, and saves the results.

result_glob_pattern: ClassVar[str] = 'adsorbml_*-*.json.gz'#
_save_relaxed_atoms#
place_on_relaxed_slab#
adsorption_energy_model#
num_placements#
fmax#
steps#
optimizer_cls#
calculate(job_num: int = 0, num_jobs: int = 1) → list[dict[str, Any]]#

Perform relaxation calculations on a subset of structures.

Splits the input data into chunks and processes the chunk corresponding to job_num.

Parameters:

  • job_num (int, optional) – Current job number in array job. Defaults to 0.

  • num_jobs (int, optional) – Total number of jobs in array. Defaults to 1.

Returns:

list[dict[str, Any]] - List of dictionaries containing calculation results

write_results(results: list[dict[str, Any]], results_dir: str, job_num: int = 0, num_jobs: int = 1) → None#

Write calculation results to a compressed JSON file.

Parameters:

  • results – List of dictionaries containing elastic properties

  • results_dir – Directory path where results will be saved

  • job_num – Index of the current job

  • num_jobs – Total number of jobs

save_state(checkpoint_location: str, is_preemption: bool = False) → bool#

Save the current state of the calculation to a checkpoint.

Parameters:

  • checkpoint_location (str) – Location to save the checkpoint

  • is_preemption (bool, optional) – Whether this save is due to preemption. Defaults to False.

Returns:

True if state was successfully saved, False otherwise

Return type:

bool

load_state(checkpoint_location: str | None) → None#

Load a previously saved state from a checkpoint.

Parameters:

checkpoint_location (str | None) – Location of the checkpoint to load, or None if no checkpoint

Contents