Metadata-Version: 2.1
Name: cogent3
Version: 2024.5.7a1
Summary: COmparative GENomics Toolkit 3: genomic sequence analysis within notebooks or on compute systems with 1000s of CPUs.
Keywords: biology,genomics,statistics,phylogeny,evolution,bioinformatics
Author-email: Gavin Huttley <Gavin.Huttley@anu.edu.au>
Requires-Python: >=3.9,<3.13
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: chardet
Requires-Dist: numpy<2
Requires-Dist: numba>0.53; python_version>='3.9' and python_version <'3.12'
Requires-Dist: numba>0.54; python_version>='3.10' and python_version <'3.12'
Requires-Dist: numba>=0.57.0; python_version=='3.11'
Requires-Dist: numba>=0.59.0; python_version=='3.12'
Requires-Dist: scipy
Requires-Dist: scitrack
Requires-Dist: stevedore
Requires-Dist: tqdm
Requires-Dist: typing_extensions
Requires-Dist: black==24.4.2 ; extra == "dev"
Requires-Dist: click==8.1.7 ; extra == "dev"
Requires-Dist: flit ; extra == "dev"
Requires-Dist: ipykernel ; extra == "dev"
Requires-Dist: ipython ; extra == "dev"
Requires-Dist: ipywidgets ; extra == "dev"
Requires-Dist: isort==5.13.2 ; extra == "dev"
Requires-Dist: jupyter_client ; extra == "dev"
Requires-Dist: jupyterlab ; extra == "dev"
Requires-Dist: jupytext ; extra == "dev"
Requires-Dist: kaleido ; extra == "dev"
Requires-Dist: matplotlib ; extra == "dev"
Requires-Dist: nbconvert>5.4 ; extra == "dev"
Requires-Dist: nbformat ; extra == "dev"
Requires-Dist: nbsphinx ; extra == "dev"
Requires-Dist: nox ; extra == "dev"
Requires-Dist: numpydoc ; extra == "dev"
Requires-Dist: pandas ; extra == "dev"
Requires-Dist: pillow ; extra == "dev"
Requires-Dist: plotly ; extra == "dev"
Requires-Dist: psutil ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest-xdist ; extra == "dev"
Requires-Dist: scriv ; extra == "dev"
Requires-Dist: sphinx ; extra == "dev"
Requires-Dist: sphinx-autobuild ; extra == "dev"
Requires-Dist: pydata_sphinx_theme ; extra == "dev"
Requires-Dist: sphinx_design ; extra == "dev"
Requires-Dist: sphinxcontrib-bibtex ; extra == "dev"
Requires-Dist: sphinxcontrib-video ; extra == "dev"
Requires-Dist: tinydb ; extra == "dev"
Requires-Dist: click==8.1.7 ; extra == "doc"
Requires-Dist: ipykernel ; extra == "doc"
Requires-Dist: ipython ; extra == "doc"
Requires-Dist: ipywidgets ; extra == "doc"
Requires-Dist: jupyter_client ; extra == "doc"
Requires-Dist: jupyterlab ; extra == "doc"
Requires-Dist: jupytext ; extra == "doc"
Requires-Dist: kaleido ; extra == "doc"
Requires-Dist: matplotlib ; extra == "doc"
Requires-Dist: nbconvert>5.4 ; extra == "doc"
Requires-Dist: nbformat ; extra == "doc"
Requires-Dist: nbsphinx ; extra == "doc"
Requires-Dist: numpydoc ; extra == "doc"
Requires-Dist: pandas ; extra == "doc"
Requires-Dist: pillow ; extra == "doc"
Requires-Dist: plotly ; extra == "doc"
Requires-Dist: psutil ; extra == "doc"
Requires-Dist: sphinx ; extra == "doc"
Requires-Dist: sphinx-autobuild ; extra == "doc"
Requires-Dist: pydata_sphinx_theme ; extra == "doc"
Requires-Dist: sphinx_design ; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex ; extra == "doc"
Requires-Dist: sphinxcontrib-video ; extra == "doc"
Requires-Dist: pandas ; extra == "extra"
Requires-Dist: plotly ; extra == "extra"
Requires-Dist: psutil ; extra == "extra"
Requires-Dist: kaleido ; extra == "extra"
Requires-Dist: black==24.4.2 ; extra == "test"
Requires-Dist: isort==5.13.2 ; extra == "test"
Requires-Dist: click==8.1.7 ; extra == "test"
Requires-Dist: kaleido ; extra == "test"
Requires-Dist: pandas ; extra == "test"
Requires-Dist: plotly ; extra == "test"
Requires-Dist: psutil ; extra == "test"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: pytest-xdist ; extra == "test"
Requires-Dist: tinydb ; extra == "test"
Requires-Dist: nox ; extra == "test"
Project-URL: Bug Tracker, https://github.com/cogent3/cogent3/issues
Project-URL: Changelog, https://github.com/cogent3/cogent3/blob/develop/changelog.md
Project-URL: Documentation, https://www.cogent3.org/
Project-URL: Source Code, https://github.com/cogent3/cogent3
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: extra
Provides-Extra: test

[![PyPI version](https://badge.fury.io/py/cogent3.svg)](https://badge.fury.io/py/cogent3)
[![Downloads](https://pepy.tech/badge/cogent3/month)](https://pepy.tech/project/cogent3)

[![Build Status](https://github.com/cogent3/cogent3/workflows/CI/badge.svg?branch=develop)](https://github.com/cogent3/cogent3/actions?workflow=CI)
[![coverall](https://coveralls.io/repos/github/cogent3/cogent3/badge.svg?branch=develop)](https://coveralls.io/github/cogent3/cogent3?branch=develop)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cogent3)
![Using Black Formatting](https://img.shields.io/badge/code%20style-black-000000.svg)

[![CodeQL](https://github.com/cogent3/cogent3/actions/workflows/codeql.yml/badge.svg)](https://github.com/cogent3/cogent3/actions/workflows/codeql.yml)

<p align="left">
  <img src="https://raw.githubusercontent.com/cogent3/cogent3.github.io/e72df8c155c100f502b6a7009347d1821ab3adef/doc/_static/c3-logo.svg" width="300">
</p>


`cogent3` is a mature python library for analysis of genomic sequence data. We endeavour to provide a first-class experience within Jupyter notebooks, but the algorithms also support parallel execution on compute systems with 1000's of processors.

## Who is it for?

### Anyone who wants to analyse sequence divergence using robust statistical models

`cogent3` is unique in providing numerous [non-stationary Markov models](http://www.ncbi.nlm.nih.gov/pubmed/25503772) for modelling sequence evolution, [including codon models](https://www.ncbi.nlm.nih.gov/pubmed/28175284). `cogent3` also includes an extensive collection of time-reversible models (again including [novel codon models](https://www.ncbi.nlm.nih.gov/pubmed/19815689)). We have done more than just invent these new methods, we have [established the most robust algorithms](https://www.ncbi.nlm.nih.gov/pubmed/19099591) for their implementation and their [suitability for real data](https://www.ncbi.nlm.nih.gov/pubmed/23935949). Additionally, there are novel signal processing methods focussed on statistical estimation of [integer period signals](https://www.ncbi.nlm.nih.gov/pubmed/21527008).

<details>
  <summary> 🎬 Demo non-reversible substitution model </summary>
    <video src="https://user-images.githubusercontent.com/3102996/253845402-f511af2c-c2e2-48bc-8f6e-f9b0f05697e9.mp4" controls="controls" style="max-height:640px">
    </video>
</details>

### Anyone who wants to undertake exploratory genomic data analysis

Beyond our novel methods, `cogent3` provides an extensive suite of capabilities for manipulating and analysing sequence data. You can manipulate sequences by their annotations, e.g.

<details>
  <summary> 🎬 Demo sequences with annotations </summary>
    <video src="https://user-images.githubusercontent.com/3102996/253847297-2611cda8-e078-4b86-a269-43fbf6ced14c.mp4" controls="controls" style="max-height:640px">
    </video>
</details>

Plus, you can read standard tabular and biological data formats, perform multiple sequence alignment using any `cogent3` substitution models, phylogenetic reconstruction and tree manipulation, manipulation of tabular data, visualisation of phylogenies and much more.

### Beginner friendly approach to genomic data analysis

Our `cogent3.app` module provides a very different approach to using the library capabilities. Expertise in structural programming concepts is not essential!

<details>
  <summary> 🎬 Demo friendly coding </summary>
    <video src="https://user-images.githubusercontent.com/3102996/253849168-a821de1a-1aad-4761-970f-e365f6b3b1cd.mp4" controls="controls" style="max-height:640px">
    </video>
</details>

## Installation?

```bash
$ pip install cogent3
```

### Install `extra` -- adds visualisation support

The `extra` group includes python libraries required for visualisation, i.e. [plotly](https://pypi.org/project/plotly/), [kaleido](https://pypi.org/project/kaleido/), [psutil](https://pypi.org/project/psutil/) and [pandas](https://pypi.org/project/pandas/).

```bash
$ pip install "cogent3[extra]"
```

### Install `dev` -- adds `cogent3` development related libraries

The `dev` group includes python libraries required for development of `cogent3`.

```bash
$ pip install "cogent3[dev]"
```

### Install the development version

```bash
$ pip install git+https://github.com/cogent3/cogent3.git@develop#egg=cogent3
```

## Project Information

`cogent3` is released under the BSD-3 license, documentation is at [cogent3.org](https://cogent3.org), while [`cogent3` code is on GitHub](https://github.com/cogent3/cogent3). If you would like to contribute (and we hope you do!), we have created a companion [`c3dev` GitHub](https://github.com/cogent3/c3dev) repo which provides details on how to contribute and some useful tools for doing so.

## Project History

`cogent3` is a descendant of [PyCogent](https://github.com/pycogent/pycogent.github.com). While there is much in common with PyCogent, the amount of change has been substantial, motivating the name change to `cogent3`. This name has been chosen because `cogent` was always the import name (dating back to [PyEvolve in 2004](https://www.ncbi.nlm.nih.gov/pubmed/14706121)) and it's Python 3 only.

Given this history, we are grateful to the multitude of individuals who have made contributions over the years. Many of these contributors were also co-authors on the original [PyEvolve](https://www.ncbi.nlm.nih.gov/pubmed/14706121) and [PyCogent](https://www.ncbi.nlm.nih.gov/pubmed/17708774) publications. Individual contributions can be seen by using "view git blame" on individual lines of code on GitHub , through git log in the terminal, and more recently the changelog.

Compared to PyCogent version 1.9, there has been a massive amount of changes. These include integration of many of the new developments on algorithms and modelling published by the [Huttley lab](https://biology.anu.edu.au/research/groups/huttley-group-bioinformatics-molecular-evolution-genomes) over the last decade. We have also modernised our dependencies. For example, we now use `plotly` for visualisation, `tqdm` for progress bar display, `concurrent.futures` and `mpi4py.futures` for parallel process execution, `nox` and `pytest` for unit testing.

## Funding

Cogent3 has received funding support from the Australian National University and an [Essential Open Source Software for Science Grant](https://chanzuckerberg.com/eoss/proposals/cogent3-python-apis-for-iq-tree-and-graphbin-via-a-plug-in-architecture/) from the Chan Zuckerberg Initiative.


<p align="center">
  &nbsp;&nbsp;&nbsp;&nbsp;
  <img src="https://webstyle.anu.edu.au/_anu/4/images/logos/2x_anu_logo_small.svg" height="100">
  &nbsp;&nbsp;&nbsp;&nbsp;
  <img src="https://chanzuckerberg.com/wp-content/themes/czi/img/logo.svg" height="110">
</p>

