Clean up ReadTree
[modiphy.git] / README.markdown
blobcb9cd34a2c3692aa513101a6392fafb0e4eb698d
1 Modiphy
2 =======
4 Library for phylogenetic analysis using Scala.
6 Why?
7 ====
9 Because I want to be able to rapidly develop evolutionary models and test them.
10 Scala is fast (enough) to run, fast to develop, and has threadless parallelism with 
11 Actors.
13 Status
14 ======
16 Currently this software is in the testing phase. Documentation is sparse.
18 Future
19 ======
21 I want to include HMM-based models (i.e. tree-HMM or phylo-HMM type features).
22 I would like to develop this into a full domain specific language.
23 It hasn't had any optimisation yet.
25 License
26 =======
28 Modiphy is licensed under the MIT/X license.
30 Building:
31 =========
33 Dependencies:
35 You need [Simple Build Tool](http://code.google.com/p/simple-build-tool/)
36 Dependencies should be automatically handled by SBT.
37 You also need Apache Ivy in the classpath for SBT:
39     sbt update # to pull in latest jars
40     sbt compile