Metadata-Version: 2.1
Name: DendroPy
Version: 5.0.1
Summary: A Python library for phylogenetics and phylogenetic computing: reading, writing, simulation, processing and manipulation of phylogenetic trees (phylogenies) and characters.
Home-page: http://github.com/jeetsukumaran/DendroPy
Author: Jeet Sukumaran, Mark T. Holder, and Matthew Andres Moreno
Author-email: jeetsukumaran@gmail.com, mtholder@ku.edu, morenoma@umich.edu
License: BSD
Project-URL: Documentation, https://jeetsukumaran.github.io/DendroPy/
Project-URL: Source, https://github.com/jeetsukumaran/DendroPy
Project-URL: Tracker, https://github.com/jeetsukumaran/DendroPy/issues
Keywords: phylogenetics phylogeny phylogenies phylogeography evolution evolutionary biology systematics coalescent population genetics phyloinformatics bioinformatics
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
License-File: AUTHORS.rst


.. image:: https://raw.githubusercontent.com/jeetsukumaran/DendroPy/DendroPy4/doc/source/_static/dendropy_logo.png
   :align: right
   :target: https://github.com/jeetsukumaran/DendroPy
   :alt: DendroPy wordmark

+--------------------+-+---------------------+-+---------------------+-+-------------------+
| *automated tests:* | | *package version:*  | | *documentation:*    | | *test coverage:*  |
|                    | |                     | |                     | |                   |
| |CI|               | | |PyPI|              | | |Docs|              | | |Coverage|        |
+--------------------+-+---------------------+-+---------------------+-+-------------------+

.. |CI| image:: https://github.com/jeetsukumaran/DendroPy/actions/workflows/ci.yaml/badge.svg
   :target: https://github.com/jeetsukumaran/DendroPy/actions/workflows/ci.yaml
   :alt: Continuous Integration build
.. |PyPI| image:: https://img.shields.io/pypi/v/DendroPy.svg
   :target: https://pypi.org/project/DendroPy/
   :alt: PyPI version
.. |Docs| image:: https://github.com/jeetsukumaran/DendroPy/actions/workflows/pages/pages-build-deployment/badge.svg
   :target: https://jeetsukumaran.github.io/DendroPy/
   :alt: Documentation Status
.. |Coverage| image:: https://codecov.io/gh/jeetsukumaran/DendroPy/graph/badge.svg?token=JwMfFOpBBD
   :target: https://codecov.io/gh/jeetsukumaran/DendroPy
   :alt: codecov coverage
.. |nbsp| unicode:: 0xA0
   :trim:


-----


DendroPy is a Python library for phylogenetic computing.
It provides classes and functions for the simulation, processing, and
manipulation of phylogenetic trees and character matrices, and supports the
reading and writing of phylogenetic data in a range of formats, such as NEXUS,
NEWICK, NeXML, Phylip, FASTA, etc.  Application scripts for performing some
useful phylogenetic operations, such as data conversion and tree posterior
distribution summarization, are also distributed and installed as part of the
libary.  DendroPy can thus function as a stand-alone library for phylogenetics,
a component of more complex multi-library phyloinformatic pipelines, or as a
scripting "glue" that assembles and drives such pipelines.

The primary home page for DendroPy, with detailed tutorials and documentation, is at:

    https://jeetsukumaran.github.io/DendroPy/

DendroPy is also hosted in the official Python repository:

    http://pypi.org/project/DendroPy/

Requirements and Installation
=============================

The current version of DendroPy requires Python 3:

You can install DendroPy by running::

    $ sudo pip install dendropy

More information is available here:

    https://jeetsukumaran.github.io/DendroPy/downloading.html

Documentation
=============

Full documentation is available here:

    https://jeetsukumaran.github.io/DendroPy/

This includes:

    -   `A comprehensive "getting started" primer <https://jeetsukumaran.github.io/DendroPy/primer/index.html>`_ .
    -   `API documentation <https://jeetsukumaran.github.io/DendroPy/library/index.html>`_ .
    -   `Descriptions of data formats supported for reading/writing <https://jeetsukumaran.github.io/DendroPy/schemas/index.html>`_ .

and more.

Citing
======

If you use any portion of DendroPy v5 in your research, please cite it as:

      Moreno, M. A., Sukumaran, J., and M. T. Holder. 2024. DendroPy 5: a mature Python library for phylogenetic computing. arXiv preprint arXiv:2405.14120. https://doi.org/10.48550/arXiv.2405.14120

For BibTex users:

.. code-block:: bibtex

      @misc{dendropy5,
         title = {DendroPy 5: a mature Python library for phylogenetic computing},
         author = {Moreno,  Matthew Andres and Sukumaran,  Jeet and Holder,  Mark T.},
         year = {2024},
         keywords = {Populations and Evolution (q-bio.PE),  FOS: Biological sciences,  FOS: Biological sciences},
         publisher = {arXiv},
         doi = {10.48550/ARXIV.2405.14120},
         url = {https://arxiv.org/abs/2405.14120},
         copyright = {arXiv.org perpetual, non-exclusive license}
      }

Earlier DendroPy versions can be cited as:

      Sukumaran, J. and M. T. Holder. 2010. DendroPy: a Python library for phylogenetic computing. Bioinformatics 26: 1569-1571. https://doi.org/10.1093/bioinformatics/btq228

Consider also leaving a `star on GitHub <https://github.com/jeetsukumaran/DendroPy/stargazers>`_!

License and Warranty
====================

Please see the file "LICENSE.rst" for details.

Developers
==========

- `Jeet Sukumaran <https://sukumaranlab.org/people/>`_
- `Mark Holder <https://phylo.bio.ku.edu/content/mark-t-holder>`_
- `Matthew Andres Moreno <https://mmore500.com/>`_
