Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New readme for msmtools #41

Merged
merged 1 commit into from
Jul 28, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -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 <http://www.numpy.org/>`_
and `SciPy <http://www.scipy.org>`_.

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 <http://github.com/markovmodel/msmtools>`__.

Or start a discussion on our mailing list: [email protected]