Code Monkey home page Code Monkey logo

crank's Introduction

Crank

Crank is designed to create a dihedral grid, and fill in optimized geometries and energies into the grid, by running wavefront propagations of constrained optimizations.

Dependencies

  • Numpy

  • geomeTRIC molecule.py, also to enable the geometric-optimize command

  • cctools.work_queue [Optional] (to enable the distributed computing feature)

Install

python setup.py install

Run

crank-launch <InputFile> <Dihedrals.txt> --init_coords <init_coords.xyz> -g <grid_spacing> -e <Engine> (--native_opt) (--wq_port XXX) (-v) > scan.log

API call

crank-api current_state.pickle

Input Parameters:

positional arguments:

<InputFile>: An Psi4, QChem or Terachem input file, servering as a template for constrained optimizations.

<Dihedrals.txt>: A txt file containing the definition of dihedral angles, each as 4 atom indices in one line. The number of dihedrals determines the dimension of the scanned grid.

optional arguments:

--init_coords <init_coords.xyz>: File contains a trajectory of initial coordinates. Will be mapped to the closest grid point at beginning, replacing the geometry in <InputFile>.

-g <grid_spacing>: Integer number, divisor of 360, angle in degree between each grid point.

-e <Engine>: One of psi4, qchem, terachem

--native_opt: Flag, use quantum software's internal optimizer instead of geomeTRIC optimizer.

--wq_port XXX: Flag, use cctools.work_queue tool to distribute the calculations.

-v: Flag, turn on verbose printing, including the colorful status map :)

Advanced Usage

The DihedralScanner Class works together with the QMEngine Class, both can be imported and incorporated into other python scripts, to enable more features, and automated scanning for multiple molecules.

crank's People

Contributors

leeping avatar yudongqiu avatar

Watchers

 avatar  avatar

Forkers

chayast

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.