Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.62 KB

README.md

File metadata and controls

61 lines (44 loc) · 2.62 KB

DOI Build Status codecov Language grade: Python License: MIT

alt text


Introduction

autodE is a Python module designed for the automated calculation of reaction profiles from just SMILES strings of reactant(s) and product(s).

Dependencies

The Python dependencies are listed in requirements.txt are best satisfied using a conda install (Miniconda or Anaconda).

Installation

To install autodE

git clone https://github.com/duartegroup/autodE.git
cd autodE
conda install --file requirements.txt --channel conda-forge
python setup.py install

see the installation guide for more detailed instructions.

Usage

Reaction profiles in autodE are generated by initialising Reactant and Product objects, generating a Reaction from those and invoking a method e.g. locate_transtion_state() or calculate_reaction_profile(). For example, to calculate the reaction profile for a 1,2 hydrogen shift in a propyl radical

from autode import *
Config.n_cores = 8

r = Reactant(name='reactant', smiles='CC[C]([H])[H]')
p = Product(name='product', smiles='C[C]([H])C')

reaction = Reaction(r, p, name='1-2_shift')
reaction.calculate_reaction_profile()

See examples/ for more examples and duartegroup.github.io/autodE/ for additional documentation.

Development

Pull requests are very welcome but must pass all the unit tests prior to being merged. Please write code and tests! Bugs and feature requests should be raised on the issue page.