Automated workflow for surface reactions.
Project description
NEBscape
Automated workflow for sampling minimum energy path for surface reactions with minimal human input.
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.
- List of reaction SMILES string in
reaction_smiles.txt(e.g.O=[C][CH2][O]>>[C-]#[O+].[CH2]=O) - slab information in
slab.xyz(Slab should use tag to indicate which atoms are fixed (tag=0) and which atoms are relaxsed(tag=1)) - 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.jsonfile has to be set for remote submission to HPC (Can be found in/example)- According to
config.json, severalremote_infoshould also be adapted on user's environment.
Documentation
- Home - overview
- Installation - installation
- Setting up local environment - setting for wfl and expyre
- Input preparation - input file preparation
- Geometry generation - running minima hopping
- Interpolation generation - generating initial minimum energy paths
(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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nebscape-0.2.0.tar.gz.
File metadata
- Download URL: nebscape-0.2.0.tar.gz
- Upload date:
- Size: 95.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b33164eae46667b1796539e25d7681c80365b03a6f6a8e7c69bb0baec58c4648
|
|
| MD5 |
38addcb5cb9817bd52703deacb6da764
|
|
| BLAKE2b-256 |
e5fc63002165f2b8441e7f2e9b82b164d3829b3d9a8fc1ff337adbcc15bb76ce
|
File details
Details for the file nebscape-0.2.0-py3-none-any.whl.
File metadata
- Download URL: nebscape-0.2.0-py3-none-any.whl
- Upload date:
- Size: 104.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
78eb1349879db7bfce0521fecfd0fc11e9a15b5d981a0855748ee9d6ce41fc7a
|
|
| MD5 |
7594166f1b6d687e803d19cbf78973d5
|
|
| BLAKE2b-256 |
cf0fccfb2db25f6e6bb596c2658ed66e2763d47a4342bac8e52e335e46921226
|