README.md 2.18 KB
Newer Older
1
2
[![GH Actions Status](https://github.com/openmm/openmm/workflows/CI/badge.svg)](https://github.com/openmm/openmm/actions?query=branch%3Amaster+workflow%3ACI)
[![Conda](https://img.shields.io/conda/v/conda-forge/openmm.svg)](https://anaconda.org/conda-forge/openmm)
3
[![Anaconda Cloud Badge](https://anaconda.org/conda-forge/openmm/badges/downloads.svg)](https://anaconda.org/conda-forge/openmm)
John Chodera (MSKCC)'s avatar
John Chodera (MSKCC) committed
4

Kyle Beauchamp's avatar
Kyle Beauchamp committed
5
6
## OpenMM: A High Performance Molecular Dynamics Library

7
### Introduction
Kyle Beauchamp's avatar
Kyle Beauchamp committed
8

9
[OpenMM](http://openmm.org) is a toolkit for molecular simulation. It can be used either as a stand-alone application for running simulations, or as a library you call from your own code. It
Kyle Beauchamp's avatar
Kyle Beauchamp committed
10
provides a combination of extreme flexibility (through custom forces and integrators), openness, and high performance (especially on recent GPUs) that make it truly unique among simulation codes.  
Kyle Beauchamp's avatar
Kyle Beauchamp committed
11

12
### Getting Help
Kyle Beauchamp's avatar
Kyle Beauchamp committed
13

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Need help using OpenMM?  There are several places that you can find it:
- [Documentation](http://docs.openmm.org/):
  - [User Manual](https://docs.openmm.org/latest/userguide/)
  - [Python API Reference](https://docs.openmm.org/latest/api-python/)
  - [C++ API Reference](https://docs.openmm.org/latest/api-c++/)
- [Getting Support](SUPPORT.md):
  - [Frequently Asked Questions](https://github.com/openmm/openmm/wiki/Frequently-Asked-Questions)
  - [Discussion Forum](https://github.com/openmm/openmm/discussions)
  - [Issue Tracker](https://github.com/openmm/openmm/issues)
- [Learning Resources](https://openmm.github.io/openmm-cookbook/latest):
  - [OpenMM Tutorials](https://openmm.github.io/openmm-cookbook/latest/tutorials)
  - [OpenMM Cookbook](https://openmm.github.io/openmm-cookbook/latest/cookbook)
  - [OpenMM Examples](examples/README.md)
- [Contributing to OpenMM](CONTRIBUTING.md):
  - [Developer Guide](https://docs.openmm.org/latest/developerguide/)

### License Information

OpenMM is free and open-source software.  There are several licenses which cover
different parts of OpenMM, but most of the source code is covered by the MIT
license or the GNU Lesser General Public License (LGPL).  Portions copyright
© 2008-2025 Stanford University and the Authors.  For more details, see
[Licenses.txt](docs-source/licenses/Licenses.txt).