Skip to content

Commit 8fa797f

Browse files
authored
Update README.md
1 parent dc61dc2 commit 8fa797f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,23 @@ calculate:
2121
+ Normalized Conditional Mutual Information
2222

2323

24+
## Documentation
25+
26+
Full documentation can be found at [http://msmbuilder.org/mdentropy/](http://msmbuilder.org/mdentropy/).
27+
For information about installation, please refer to our [Installation](http://msmbuilder.org/mdentropy/0.3.0/installation.html) page.
28+
29+
We also have [example notebooks](http://msmbuilder.org/mdentropy/0.3.0/examples/index.html) with common use cases for MDEntropy.
30+
Please feel free to add your own as a pull-request!
31+
32+
## Requirements
33+
34+
+ `python`>=3.4
35+
+ `numpy`>=1.10.4
36+
+ `scipy`>=0.17.0
37+
+ `scikit-learn`>=0.17.0
38+
+ `msmbuilder`>=3.5.0
39+
+ `nose` (optional, for testing)
40+
2441
## Citing
2542

2643
Please cite:

0 commit comments

Comments
 (0)