Skip to main content

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.

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.1.tar.gz (118.6 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.1-py3-none-any.whl (127.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nebscape-0.3.1.tar.gz
  • Upload date:
  • Size: 118.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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.1.tar.gz
Algorithm Hash digest
SHA256 50d095b9a06422fc3bd3056e7d5b3a92baa68e6d8719b03e7dcdb06a8ca8c7e0
MD5 f7939c461e56ce9181e44c07763ac153
BLAKE2b-256 9a234c8a07c2fbe23e84c4cc6fdbdca5b5807c862d003f23af8a2442ce4abea7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nebscape-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 127.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a1bf54877dec99e96a0732e9e538893282c9f829c7ac5ce4249075f73b89549
MD5 1564b1fbe9708b4b97577e13c01210ae
BLAKE2b-256 1b25c8f75cd03af808a7ea96532b0af98b6d060d1c7151834d0d3bd701fad5f6

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page