Git Product home page Git Product logo

westpa's Introduction

WESTPA 1.0

Overview

WESTPA is a package for constructing and running stochastic simulations using the "weighted ensemble" approach of Huber and Kim (1996). For use of WESTPA please cite the following:

Zwier, M.C., Adelman, J.L., Kaus, J.W., Pratt, A.J., Wong, K.F., Rego, N.B., Suarez, E., Lettieri, S., Wang, D. W., Grabe, M., Zuckerman, D. M., and Chong, L. T. "WESTPA: An Interoperable, Highly Scalable Software Package For Weighted Ensemble Simulation and Analysis," J. Chem. Theory Comput., 11: 800โˆ’809 (2015).

See this page for an overview of weighted ensemble simulation.

To help us fund development and improve WESTPA please fill out a one-minute survey and consider contributing documentation or code to the WESTPA community.

WESTPA is free software, licensed under the terms of the MIT License. See the file LICENSE for more information.

Installing WESTPA

First, install the Anaconda Python distribution. Then, make sure you are able to activate conda environments (this is usually taken care of by the Anaconda installer).

WESTPA can then be installed through conda in a dedicated environment with the following.

conda create -n westpa -c conda-forge westpa

WESTPA will be ready to use after activation with the following command.

. $(dirname $(dirname `which python2.7`))/$conda_env/westpa-2017.10/westpa.sh

Feel free to install any other conda packages alongside WESTPA in your environment. AmberTools, GROMACS and OpenMM all provide conda installations of their MD packages. An example command to create an environment containing WESTPA and AmberTools is given below.

conda create -n westpa -c conda-forge -c ambermd westpa ambertools

Getting started

To define environment variables post-installation, simply source the westpa.sh script in the westpa directory from the command line or your setup scripts.

High-level tutorials of how to use the WESTPA software can be found here. Further, all WESTPA command-line tools (located in westpa/bin) provide detailed help when given the -h/--help option.

Finally, while WESTPA is a powerful tool that enables expert simulators to access much longer timescales than is practical with standard simulations, there can be a steep learning curve to figuring out how to effectively run the simulations on your computing resource of choice. For serious users who have completed WESTPA tutorials and are ready for production simulations of their system, we invite you to contact Lillian Chong (ltchong AT pitt DOT edu) about visiting her lab and/or setting up video conferencing calls to help get your simulations off the ground.

Getting help

A mailing list for WESTPA is available, at which one can ask questions (or see if a question one has was previously addressed). This is the preferred means for obtaining help and support. See http://groups.google.com/group/westpa-users to sign up or search archived messages.

westpa's People

Contributors

mczwier avatar asinansaglam avatar synapticarbors avatar ltchong avatar ajd98 avatar karltdebiec avatar lewbaker avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar  avatar

westpa's Issues

Store Files

Some files common to all segments (and unchanged) but storing them with each segment would result in a lot of wasted space. There should be a mechanism for storing important files that you just need one copy of.

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.