Welcome to OpenFE’s documentation!#

The OpenFE toolkit provides a free and open-source framework for alchemical free energy calculations. Using this toolkit you can plan, execute, and analyze free energy calculations using a variety of methods.

Useful Links: OpenFE Website | Example Tutorial notebooks | Source Repository | Issues & Ideas

Install openfe

Follow our installation guide to get openfe running on your machine!

Installation
CLI Quickstart

Get started with openfe's command line interface.

Binding Free Energies with the OpenFE CLI
Tutorials

Step-by-step examples showing how to use the OpenFE toolkit.

Tutorials
User Guide

Explanations of key concept underlying the OpenFE toolkit.

User Guide
Cookbooks

How-to guides for common tasks.

Cookbook
API Reference

Comprehensive details of the openfe Python and CLI APIs.

Reference
Protocols

Details of the specific Free Energy Protocols included in openfe.

Details of Specific Protocols
Changelog

A history of openfe releases.

Changelog

Other OpenFE Ecosystem Projects:#

openfe is Open Free Energy’s user-facing software for performing alchemical free energy calculations. Below are other software projects the Open Free Energy team maintains, many of which are used by openfe itself.

  • konnektor: free energy network planning, modification, and analysis

  • kartograf: atom mappings focusing on 3D geometries

  • Lomap: planning perturbation networks for free energy calculations

  • cinnabar (formerly arsenic): plotting free energy calculation results

  • gufe : data structures and models underlying the OpenFE ecosystem

Community-Developed Projects:#