Frequently Asked Questions (FAQ)ΒΆ

  1. Can you restart a simulation once its finished (or interrupted)?

    Yes! Either specify the resume_simulation in the YAML file, or use the yank.yank.AlchemicalPhase.from_storage() function to resume from existing file.

  2. Which MPI program should I use?

    We recommend the mpich and mpi4py packages that come from the conda-forge channel of conda. These should be installed automatically if you installed YANK through conda correctly. If you use conda’s MPI package, do not use your local cluster’s MPI module if it has one. If you wish to use your own MPI package, make sure the mpi4py you install is compiled against your local MPI, otherwise you may see difficult to diagnose errors.

  3. How do I add a new state to the protocols section of a YAML file?

    You can allow YANK to fully specify the alchemical protocol for you with the auto argument for the alchemical path, instead of adding each state by hand. You can see its full usage documentation or its implementation information

    If you want to add states by hand, follow these instructions:

    1. Find the phase you want to change in the YAML file
    2. Add an entry in each list of values for a given parameter at the index of that list where you wish to insert the state

    See the protocols documentation for more information or watch our video guide to see how to add a state

  4. I found a bug or want a feature. Where do I tell you?

    Head to YANK’s GitHub page and post an issue.

  5. I want to contribute to YANK. What is the procedure for doing so?

    1. Install YANK from source or make a fork.
    2. Make your changes on a new branch
    3. Open a Pull Request on GitHub
    4. We’ll discuss in on GitHub now as though it were an issue, request changes, and get your changes in!

  6. What is the airspeed velocity of an unladen swallow?

    African or European?