-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from trendelkampschroer/readme
New readme for msmtools
- Loading branch information
Showing
1 changed file
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |