Skip to content

Commit

Permalink
[no ci] RTD: skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
raimis committed Feb 23, 2017
1 parent 87e028f commit 9085cfb
Show file tree
Hide file tree
Showing 4 changed files with 423 additions and 0 deletions.
File renamed without changes.
58 changes: 58 additions & 0 deletions README.rst
@@ -0,0 +1,58 @@

**The project is still under construction!**

Introduction
============

*PyBias* is a *PLUMED* plug-in with an embeded *Python* interpreter.

Key Features
------------

* All system *Python* modules can be used inside
* Built-in module to access information from PLUMED
* No PLUMED re-compilation needed

Simple Example
==============

.. code-block:: bash
# plumed.dat
LOAD FILE=libpybias.so
d: DISTANCE ATOMS=1,2
PYBIAS ARG=d
.. code-block::
# bias.py
import numpy as py
def bias(position, force):
force[:] = 0.
return 0.
Quick Installation
==================

If your are lucky (*i.e.* your system already has all dependencies), it is just
a 5-step process::

git clone https://github.com/raimis/plumed-pybias.git
cd plumed-pybias
cmake .
make
make install

Tutorials
=========



0 comments on commit 9085cfb

Please sign in to comment.