Metadata-Version: 2.3
Name: mdeq
Version: 2026.49.24
Summary: mdeq: mutation disequilibrium analysis tools.
Keywords: biology,genomics,statistics,phylogeny,evolution,bioinformatics
Author: Katherine Caley, Gavin Huttley
Author-email: Katherine Caley <katherine.caley@anu.edu.au>, Gavin Huttley <Gavin.Huttley@anu.edu.au>
License: BSD 3-Clause License
         
         Copyright (c) 2022, GavinHuttley
         All rights reserved.
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         1. Redistributions of source code must retain the above copyright notice, this
            list of conditions and the following disclaimer.
         
         2. Redistributions in binary form must reproduce the above copyright notice,
            this list of conditions and the following disclaimer in the documentation
            and/or other materials provided with the distribution.
         
         3. Neither the name of the copyright holder nor the names of its
            contributors may be used to endorse or promote products derived from
            this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: cogent3>=2026.9.10
Requires-Dist: scinexus
Requires-Dist: click
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: scitrack
Requires-Dist: rich
Requires-Dist: trogon
Requires-Python: >=3.11, <3.15
Description-Content-Type: text/markdown

[![Coverage Status](https://coveralls.io/repos/github/HuttleyLab/MutationDiseq/badge.svg)](https://coveralls.io/github/HuttleyLab/MutationDiseq)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![DOI](https://zenodo.org/badge/351654591.svg)](https://doi.org/10.5281/zenodo.16829613)

# mdeq: a tool for analysing mutation disequilibrium

A preprint is available [here](https://www.biorxiv.org/content/10.1101/2025.08.22.671660v1). Associated analyses are [here](https://github.com/HuttleyLab/MutationDiseqAnalysis).

## Installation

```
$ pip install mdeq
```

> **Note**
> `accupy` is an optional package for the most numerically accurate routines involving matrices (e.g. dot products). These routines are explicitly employed for computing the nabla related statistics and are used if this package is installed. Unfortunately it is not easily installed and (at the time of writing) is not under active development. Use the Docker container [here](https://github.com/HuttleyLab/MutationDiseqAnalysis) to get an Ubuntu VM with this library, accupy and other useful dependencies.

## The available commands

<!-- [[[cog
import cog
from mdeq import main
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(main, ["--help"])
help = result.output.replace("Usage: main", "Usage: mdeq")
cog.out(
    "```\n{}\n```".format(help)
)
]]] -->
```
Usage: mdeq [OPTIONS] COMMAND [ARGS]...

  mdeq: mutation disequilibrium analysis tools.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  tui              Open Textual TUI.
  prep             pre-process alignment data.
  make-adjacent    makes sqlitedb of adjacent alignment records.
  toe              test of existence of mutation equilibrium.
  teop             between branch equivalence of mutation process test
  aeop             between loci equivalence of mutation process test
  convergence      estimates convergence towards mutation equilibrium.
  make-controls    simulate negative and positive controls
  db-summary       displays summary information about a db
  extract-pvalues  extracts p-values from TOE sqlitedb results
  extract-nabla-c  extracts nabla-c from convergence sqlitedb results
  slide            generate window sized sub-alignments.

```
<!-- [[[end]]] -->
