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.2.1.tar.gz (95.9 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.2.1-py3-none-any.whl (105.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nebscape-0.2.1.tar.gz
  • Upload date:
  • Size: 95.9 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

Hashes for nebscape-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5d6d1d20eda6a38d49bc644095e7a9d94e06ef5aa4de4e286e0af455faa9ae4e
MD5 d4148a643b12f4adc557bb1d896871e8
BLAKE2b-256 b660fa14a394200eab708451f04027056e463cb0104cbc2a27a4f90728bf9088

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nebscape-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 105.2 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

Hashes for nebscape-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3cc976bba511cebf527add794d580465c77d4c43a74e14b81ffe3d629f160d77
MD5 79235e54452be86ebf66769bded75cfa
BLAKE2b-256 c15fd03f787072dc0d3b3a26bb3fa31981f82515f4601d15a65fe427181390e8

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