zadorlab / KinBot

Automated reaction pathway search for gas-phase molecules
Other
45 stars 15 forks source link
atmospheric-chemistry automation chemistry combustion gas-phase-molecules kinetics potential-energy-surfaces

Gitter chat

KinBot: Automated Reaction Kinetics of Gas-Phase Organic Species over Multiwell Potential Energy Surfaces

Description

This repository contains the KinBot code version 2.2.1, a tool for automatically searching for reactions on the potential energy surface.

If you are using this tool in scientific publications, please reference the following publications:

@article{Zador2022,
   author = {Z\'ador, Judit and Mart\'i, Carles and Van de Vijver, Ruben and Johansen, Sommer L. and Yang, Yoona and Michelsen, Hope A. and Najm, Habib N.},
   title = {Automated reaction kinetics of gas-phase organic species over multiwell potential energy surfaces},
   journal = {J. Phys. Chem. A},
   volume = {127},
   pages = {565-588},
   year = {2023},
   type = {Journal Article}
}

We appreciate if you send us the DOI of your published paper that used KinBot, so we can feature it here below.

How to Install

KinBot can be installed both in three different ways, from the PyPI index (pip install), from the conda-forge repo (conda install) or by cloning this github repo and then install it locally.

PyPI

pip install kinbot

Note KinBot only works with Python >= 3.10.

conda-forge

conda install -c conda-forge kinbot

From Github

If you want to have the very last version of KinBot without waiting for a release or you want to modify KinBot acccording to your needs you can clone the project from github:

git clone git@github.com:zadorlab/KinBot.git

and then, from within the KinBot directory produced after cloning, type:

pip install -e .

Note If you want to modify KinBot yourself it's better to fork the project into your own repository and then clone it.

How to Run

To run a single-well exploration of KinBot, make an input file (e.g. input.json) and run:

kinbot input.json

To run a full PES search, make an input file (e.g. input.json) and run:

pes input.json

You can find additional command line arguments in the manual.

Documentation

See the wiki for keywords, and our tutorial for a more hands-on introduction to the code.

List of files in this project

See list.

Authors

Papers using KinBot

Older Version of KinBot:

Acknowledgement

This research was supported by the Exascale Computing Project (ECP), Project Number: 17-SC-20-SC, a collaborative effort of two DOE organizations, the Office of Science and the National Nuclear Security Administration, responsible for the planning and preparation of a capable exascale ecosystem including software, applications, hardware, advanced system engineering, and early test bed platforms to support the nation's exascale computing imperative. RVdV was also supported by the AITSTME project as part of the Predictive Theory and Modeling component of the Materials Genome Initiative. Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA0003525.