choderalab / yank-examples

Examples for use of YANK - getyank.org
MIT License
12 stars 8 forks source link

Travis Build Status Anaconda Cloud Badge Anaconda Cloud Downloads DOI

Examples for YANK

This repository houses the examples for YANK. Here you will find all the files needed to run sample simulations in YANK to see its functionality in action.

Detailed guides are available to guide you through these examples through the YANK webpage.

Installation Instructions

Requirements

Installing through conda

We make this repository through the omnia conda channel for easy install. The files will be put in {Python Source Dir}/share/yank/examples

conda install -c conda-forge -c omnia yank-examples

Installing from "source"

There is no source code with these examples per-se. Just clone the repository into any directory you prefer, so long as the pre-requisites are installed.

Included Examples

All example files are in the examples folder.

Current YAML Revision: 1.2

The examples here on GitHub will be ahead of those released on conda. This section tracks the highest YAML code revision in YANK that can be used with these examples.

YAML code revisions are backwards compatible for a given major revision (e.g. YAML Version 1.2 will accept scripts built for version 1.0)