Skip to main content

Automated workflow for surface reactions.

Project description

NEBscape

ChemRxiv DOI

License: MIT

Tests Passing Ruff

Automated workflow for sampling minimum energy path for surface reactions with 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 possbile 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 relaxsed(tag=1))
  3. Calculator (e.g. MLIP like MACE)

Setting

This workflow uses wfl and expyre for remote submission, so it is advised to configure related settings

  • config.json file has to be set for remote submission to HPC (Can be found in /example)
  • According to config.json, several remote_info should also be adapted on user's 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.1.0.tar.gz (87.5 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.1.0-py3-none-any.whl (96.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nebscape-0.1.0.tar.gz
  • Upload date:
  • Size: 87.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for nebscape-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c43c0506b82e2977202eb82d98b9f582b5a207585172909a6daa711af88f37bd
MD5 f8470a382f97599bf28ecd7184da42ed
BLAKE2b-256 85daa7d0fd6316c01a6af57d8b69c293e8751ed0b4ceba742ad5a1b405a7b3ba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nebscape-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 96.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for nebscape-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e4a45449d3ef3d401cc1207ff1d36c4c053442194e68055651a2fed129e1f5b
MD5 403e9590473dc6942752ab77a93d6350
BLAKE2b-256 b33e2b2072b411a1ef24dd6f78cccaa0a78d886e1f8e5ba6431527279d9469e7

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