Skip to main content

Automated workflow for surface reactions.

Project description

NEBscape

ChemRxiv DOI

License: MIT PyPI version Tests Passing Ruff

NEBscape automates the sampling of minimum energy paths (MEPs) for surface reactions, combining global geometry optimization, atom-mapping, and NEB calculations into a single workflow — requiring minimal human input.

image

Installation from source

git clone https://gitlab.mpcdf.mpg.de/hjung/nebscape.git
pip install .

Required Inputs

This workflow prepares initial and final geometry with global optimization (e.g. minima hopping) and provides automatic atom-mapping and generates possible permutation of symmetric atoms. Only following three inputs are required.

  1. List of reaction SMILES string in reaction_smiles.txt (e.g. O=[C][CH2][O]>>[C-]#[O+].[CH2]=O)
  2. slab information in slab.xyz (Slab should use tag to indicate which atoms are fixed (tag=0) and which atoms are relaxed(tag=1))
  3. Calculator (e.g. MLIP like MACE)

Setting

This workflow uses wfl and expyre for remote submission, so configure the following related settings

  • config.json file has to be set for remote submission to HPC (Can be found in /example)
  • According to config.json, the remote_info entries should be adapted to your environment.

Documentation

(We are currently working on improving the documentation / tutorial. Let us know if you need help or suggestions.)

References

If you use this code, please cite our paper:

Hyunwook Jung, Emanuel Colombi Manzi, Tiago J. Goncalves, et al. From Global Optimization to Transition State Search: An Automated Workflow for Surface Reaction Barriers. ChemRxiv. 17 April 2026.

https://doi.org/10.26434/chemrxiv.15002133/v1

@article{
doi:10.26434/chemrxiv.15002133/v1,
author = {Hyunwook Jung  and Emanuel Colombi Manzi  and Tiago J. Goncalves  and Vanessa J. Bukas  and Sandip De  and Johannes T. Margraf  and Karsten Reuter  and Hendrik H. Heenen },
title = {From Global Optimization to Transition State Search: An Automated Workflow for Surface Reaction Barriers},
journal = {ChemRxiv},
volume = {2026},
number = {0417},
pages = {},
year = {2026},
doi = {10.26434/chemrxiv.15002133/v1},
URL = {https://chemrxiv.org/doi/abs/10.26434/chemrxiv.15002133/v1},
eprint = {https://chemrxiv.org/doi/pdf/10.26434/chemrxiv.15002133/v1}}

Contact

If you have any questions, please contact us at hjung@fhi.mpg.de Also for any bugs or issues, you can use gitlab issues.

License

The NEBscape code is published and distributed under the MIT License.

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

nebscape-0.3.0.tar.gz (115.0 kB view details)

Uploaded Source

Built Distribution

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

nebscape-0.3.0-py3-none-any.whl (124.4 kB view details)

Uploaded Python 3

File details

Details for the file nebscape-0.3.0.tar.gz.

File metadata

  • Download URL: nebscape-0.3.0.tar.gz
  • Upload date:
  • Size: 115.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nebscape-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a92823f8a253e34c957107019b76b4f94a7d9cd94fd183cea8d23f4735e8db8c
MD5 effdd02abbd0d2ca0ebfd1d2c9885ff4
BLAKE2b-256 543ec384492692ab037cef6b6ab5bee6356bf0ebb3b9892c0983b8e7b3d16e6a

See more details on using hashes here.

File details

Details for the file nebscape-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: nebscape-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 124.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nebscape-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7d88c72463f9590b2697d80bb33beb8d2c57a7a14472e7a2a32d630b8825c43
MD5 2f76ee5fe51f4d3e3737a46c8c9b9fe6
BLAKE2b-256 673b16da3c1a85677d63c0a5eebb88981b1b3b8edc5aafeed3438c9cfb5d36a1

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