========
Overview
========

This `OpenMM`_ plugin provides Platform-agnostic Force classes.

Installation and Usage
======================

OpenMM-CPP-Forces is available as a conda package on the `mdtools`_ channel. To install it, run:

.. code-block:: bash

    conda install -c conda-forge -c mdtools openmm-cpp-forces

Or:

.. code-block:: bash

    mamba install -c mdtools openmm-cpp-forces

To use OpenMM-CPP-Forces in your own Python script or Jupyter notebook, simply import it as follows:

.. code-block:: python

    import openmmcppforces


.. _OpenMM:  https://openmm.org
.. _mdtools: https://anaconda.org/mdtools/openmm-cpp-forces