adaptive-sampling¶
A Python framework to run adaptive Markov state model (MSM) simulation on HPC resources
The generation of MSMs requires a huge amount of trajectory data to be analyzed. In most cases this leads to an enhanced understanding of the dynamics of the system which can be used to make decision about collection more data to achieve a desired accuracy or level of detail in the generated MSM. This alternating process between simulation/actively generating new observations and analysis is currently difficult and involves lots of human decision along the path.
This framework aim to automate this process with the following goals:
- Ease of use: Simple system setup once an HPC has been added.
- Flexibility: Modular setup, attach to multiple HPCs and different simulation engines
- Automatism: Create an user-defined adaptive strategy that is executed
- Compatibility: Build analysis tools and export to known formats
Prerequisites¶
There are a few things we need to install to make this work.
MongoDB¶
AdaptiveMD and RP both need access to a MongoDB. The FU has one that Allegro can access in place and you can use this for storing projects. If you want to store these locally you need to install MongoDB.
Just download your OS installer from MongoDB Community Edition and follow the installation instructions. This is very straight forward and should work without any problems. You only need to install MongoDB on your local machine from which you will connect to the cluster. No need to install it on the cluster.
curl -O https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-debian81-3.4.2.tgz
tar -zxvf mongodb-linux-x86_64-debian81-3.4.2.tgz
mkdir -p ~/mongodb
cp -R -n mongodb-linux-x86_64-debian81-3.4.2/ ~/mongodb
# add PATH to .bashrc
echo "export PATH=~/mongodb/bin:$PATH" >> ~/.bash_rc
# create directory for storage (everywhere you have space)
mkdir -p ~/mongodb/data/db
# run the deamon in the background
mongod --quiet --dbpath ~/mongodb/data/db &
Conda¶
Whereever you will run the actual tasks (local or a cluster) you probably use some python so we recommend to install the common set of conda packages. If you are remotely executing python then you can even use python 3 without problems. The RPC might also work with python 3 but that needs to be tested.
If you have not yet installed conda please do so using
# curl -O https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh
# bash Miniconda2-latest-Linux-x86_64.sh
or in analogy for python3
Add 2 useful channels
conda config --append channels conda-forge
conda config --append channels omnia
and --append will make sure that the regular conda packages are tried first and use conda-forge and omnia as a fallback.
Install required and necessary packages now
# for adaptivemd only
conda install ujson pyyaml pymongo=2.8 numpy
# for openmm, pyemma etc
conda install pyemma openmm mdtraj
Install adaptiveMD¶
Let’s get adaptivemd from the github repo now.
# clone and install adaptivemd
git clone git@github.com:markovmodel/adaptivemd.git
# go to adativemd
cd adaptivemd/
# and install it
python setup.py develop
# see if it works
python -c "import adaptivemd" || echo 'FAILED'
# run a simple test
cd adaptive/tests/
python test_simple.py
All of this must also be installed on the cluster, where you want to run your simulations.
For allegro I suggest to use a miniconda installation. Note that you only need these packages if you want to use some of it on the cluster like run openmm or make computations using pyemma. Just for running, say acemd conda is not required!
That’s it. Have fun running adaptive simulations.
Documentation¶
To compile the doc pages, clone this github repository, go into the docs folder and do
conda install sphinx sphinx_rtd_theme pandoc
make html
The HTML pages are in _build/html. Please note that the docs can only be compiled if all the above mentionend AdaptiveMD dependencies are available. If you are using conda environments, this means that your AdaptiveMD environment should be active.
You might want to start with the examples in examples/tutorials