From 4c281c382f1129b80a0b7d63cfa81ffd8fe285d4 Mon Sep 17 00:00:00 2001 From: Benjamin Trendelkamp-Schroer Date: Tue, 28 Jul 2015 14:39:53 +0200 Subject: [PATCH] NEw readme for msmtools --- README.rst | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 12e2e5b6..4b3dbf1c 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,34 @@ MSMTools ======== -desc +What is it? +----------- +msmtools is an open source collection of algorithms for the estimation +and analysis of discrete state space Markov chains via Markov state +models (MSM). + +The algorithms are implemented using `NumPy `_ +and `SciPy `_. + +Installation +------------ +With pip:: + + pip install msmtools + +with conda:: + + conda install -c https://conda.binstar.org/omnia msmtools + + +or install latest devel branch with pip:: + + pip install git+https://github.com/markovmodel/msmtools.git@devel + + +Support and development +----------------------- +For bug reports/sugguestions/complains please file an issue on +`GitHub `__. + +Or start a discussion on our mailing list: pyemma-users@lists.fu-berlin.de