Giter Club home page Giter Club logo

whampy's Introduction

whampy

whampy is a python3 script that performs a WHAM calculation on umbrella sampling datasets in order to obtain a potential of mean force.

Getting Started

Prerequisites

Disclaimer: program in development

  • python3.x must be installed.
  • The following python packages must be installed:
    • numpy
    • scipy
    • matplotlib
  • These can be installed with pip

whampy instructions

The whampy" program computes the potential of mean force of an umbrella sampling simulation using a minimization of a log-likelihood function of the probability distribution in 1D.

The execution of the program is as follows:

python3 wham.py [-h] [-s] [-i INPUT] [-o OUTPUT]

where the INPUT file is a plain text file with the format as specified in example/example.in. The trajectory files sourced from the paths found in the input file are assumed to be in the two-column NAMD .traj format as shown in the example/example.traj file.

For more information about the options, the [-h] optional flag brings up the help text.

Test execution

A simple calculation of the potential of mean force of the rotation of the C2-C3 dihedral angle of butane is provided for testing purposes.

To execute the test, the following command suffices:

python3 wham.py -i example/input/example.in -o example/output/test

The results of the PMF will then be stored in example/output/test.pmf, with the reaction coordinate in the first column, the PMF value in the second column, and the standard error of the PMF value in the third.

Plotting these results with the first column at the x-axis and the second column at the y-axis will produce results equivalent to those contained in the provided .png file.

=======

The 'montecarlo' branch includes a modified version of the code that also generates a dataset with Monte Carlo, useful for testing.

whampy's People

Contributors

enfo14 avatar

Stargazers

 avatar  avatar  avatar Nithishwer Mouroug Anand avatar Neven Golenić avatar

Watchers

James Cloos avatar

whampy's Issues

Jupyter Notebook

It would be nice to have an example of implementation and use in a notebook for teaching purposes.

Licensing

There is no information about licensing, which makes usage and changes quite difficult.

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.