File: README.textile

package info (click to toggle)
spread-phy 1.0.7%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 99,904 kB
  • sloc: java: 19,427; xml: 200; sh: 58; makefile: 6
file content (71 lines) | stat: -rw-r--r-- 2,632 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
===================
.:: SPREAD ::.
===================
*Spatial Phylogenetic Reconstruction of Evolutionary Dynamics*
Version: 1.0.7, 2015
Authors: Filip Bielejec, Andrew Rambaut, Marc A. Suchard & Philippe Lemey
Homepage: www.phylogeography.org
License: LGPL

h1. LICENSE

  This is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
 
   This software is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   "GNU Lesser General Public License":http://www.gnu.org/licenses/lgpl.html for more details.
 
h1. PURPOSE
                            
SPREAD is a Java program supporting processing and visualizations of BEAST's phylogeographic models ("BEAST software":http://beast.bio.ed.ac.uk/Main_Page). 

Contains visualisations (templates), wrapped in a user friendly interface. Supported visualisations include embedded Processing applets and KML output for viewing in "Google Earth":http://www.google.com/earth or any other virtual globe software capable of reading the format.

A tutorial on using SPREAD is availiable "here":http://www.kuleuven.be/aidslab/phylogeography/tutorial/spread_tutorial.html

h1. SUPPORT & LINKS

SPREAD: www.phylogeography.org/SPREAD
PROCESSING libraries: http://processing.org/ 

Suggestions or bug reports:

<filip.bielejec(_sorry_spybots_)rega.kuleuven.be>

h1. COMPILING

Depends on the following libraries:

* jebl.jar
* core.jar
* colt.jar
* quaqua.jar (libquaqua64.jnilib, libquaqua.jnilib)

h1. CONTRIBUTING

You're interested in contributing to SPREAD? *THAT'S AWESOME!* Here are the basic steps:

1. fork SPREAD from here: http://github.com/phylogeography/SPREAD
2. Hack, hack, hack!
3. Document your changes in the Changelog
5. Push the changes
6. Send a pull request to the phylogeography/SPREAD project.

h1. TODO

* Left panel stretches if a parsed attribute name is long
* (Continous Tree) Relate the HPD areas shown as polygons in GoogleEarth with specific nodes of the tree
* Rewrite Log file reader 
* Mean tree calculation (from .trees file)
* Combobox for relaxed (from parser) / standard brownian motion (rate of 1)
* Annotate the terminals in the tree with corresponding taxon names
* Move all the parsing code to reader classes for trees -> avoid code duplication  
* Add command line interface for kml templates 
* Fix large scaling factor issues
* Spread v2.0