README.rst
1.. image:: https://raw.githubusercontent.com/jeetsukumaran/DendroPy/DendroPy4/doc/source/_static/dendropy_logo.png
2 :align: right
3 :alt: DendroPy
4
5DendroPy is a Python library for phylogenetic computing.
6It provides classes and functions for the simulation, processing, and
7manipulation of phylogenetic trees and character matrices, and supports the
8reading and writing of phylogenetic data in a range of formats, such as NEXUS,
9NEWICK, NeXML, Phylip, FASTA, etc. Application scripts for performing some
10useful phylogenetic operations, such as data conversion and tree posterior
11distribution summarization, are also distributed and installed as part of the
12libary. DendroPy can thus function as a stand-alone library for phylogenetics,
13a component of more complex multi-library phyloinformatic pipelines, or as a
14scripting "glue" that assembles and drives such pipelines.
15
16The primary home page for DendroPy, with detailed tutorials and documentation, is at:
17
18 http://dendropy.org/
19
20DendroPy is also hosted in the official Python repository:
21
22 http://packages.python.org/DendroPy/
23
24Requirements and Installation
25=============================
26
27DendroPy 4.x runs under Python 3 (all versions > 3.1) and Python 2 (Python 2.7 only).
28
29You can install DendroPy by running::
30
31 $ sudo pip install dendropy
32
33More information is available here:
34
35 http://dendropy.org/downloading.html
36
37Documentation
38=============
39
40Full documentation is available here:
41
42 http://dendropy.org/
43
44This includes:
45
46 - `A comprehensive "getting started" primer <http://dendropy.org/primer/index.html>`_ .
47 - `API documentation <http://dendropy.org/library/index.html>`_ .
48 - `Descriptions of data formats supported for reading/writing <http://dendropy.org/schemas/index.html>`_ .
49
50and more.
51
52License and Warranty
53====================
54
55Please see the file "LICENSE.rst" for details.
56
