mdeq 2025.6.30__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
mdeq-2025.6.30/LICENSE ADDED
@@ -0,0 +1,29 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2022, GavinHuttley
4
+ All rights reserved.
5
+
6
+ Redistribution and use in source and binary forms, with or without
7
+ modification, are permitted provided that the following conditions are met:
8
+
9
+ 1. Redistributions of source code must retain the above copyright notice, this
10
+ list of conditions and the following disclaimer.
11
+
12
+ 2. Redistributions in binary form must reproduce the above copyright notice,
13
+ this list of conditions and the following disclaimer in the documentation
14
+ and/or other materials provided with the distribution.
15
+
16
+ 3. Neither the name of the copyright holder nor the names of its
17
+ contributors may be used to endorse or promote products derived from
18
+ this software without specific prior written permission.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,92 @@
1
+ Metadata-Version: 2.4
2
+ Name: mdeq
3
+ Version: 2025.6.30
4
+ Summary: mdeq: mutation disequilibrium analysis tools.
5
+ Keywords: biology,genomics,statistics,phylogeny,evolution,bioinformatics
6
+ Author-email: Katherine Caley <katherine.caley@anu.edu.au>, Gavin Huttley <Gavin.Huttley@anu.edu.au>
7
+ Requires-Python: >=3.10,<3.14
8
+ Description-Content-Type: text/markdown
9
+ Classifier: Development Status :: 5 - Production/Stable
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: License :: OSI Approved :: BSD License
12
+ Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
13
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ License-File: LICENSE
20
+ Requires-Dist: cogent3>=2025.7.10a5
21
+ Requires-Dist: click
22
+ Requires-Dist: numpy
23
+ Requires-Dist: scipy
24
+ Requires-Dist: scitrack
25
+ Requires-Dist: rich
26
+ Requires-Dist: trogon
27
+ Requires-Dist: cogapp ; extra == "dev"
28
+ Requires-Dist: docformatter ; extra == "dev"
29
+ Requires-Dist: mdeq[test] ; extra == "dev"
30
+ Requires-Dist: ruff==0.12.8 ; extra == "dev"
31
+ Requires-Dist: pytest ; extra == "test"
32
+ Requires-Dist: pytest-cov ; extra == "test"
33
+ Requires-Dist: pytest-xdist ; extra == "test"
34
+ Requires-Dist: nox ; extra == "test"
35
+ Provides-Extra: dev
36
+ Provides-Extra: test
37
+
38
+ [![Coverage Status](https://coveralls.io/repos/github/HuttleyLab/MutationDiseq/badge.svg)](https://coveralls.io/github/HuttleyLab/MutationDiseq)
39
+ [![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)
40
+
41
+ # mdeq: a tool for analysing mutation disequilibrium
42
+
43
+ A manuscript describing the methods will be made available as a preprint soon.
44
+
45
+ ## Installation
46
+
47
+ ```
48
+ $ pip install mdeq
49
+ ```
50
+
51
+ > **Note**
52
+ > `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.
53
+
54
+ ## The available commands
55
+
56
+ <!-- [[[cog
57
+ import cog
58
+ from mdeq import main
59
+ from click.testing import CliRunner
60
+ runner = CliRunner()
61
+ result = runner.invoke(main, ["--help"])
62
+ help = result.output.replace("Usage: main", "Usage: mdeq")
63
+ cog.out(
64
+ "```\n{}\n```".format(help)
65
+ )
66
+ ]]] -->
67
+ ```
68
+ Usage: mdeq [OPTIONS] COMMAND [ARGS]...
69
+
70
+ mdeq: mutation disequilibrium analysis tools.
71
+
72
+ Options:
73
+ --version Show the version and exit.
74
+ --help Show this message and exit.
75
+
76
+ Commands:
77
+ tui Open Textual TUI.
78
+ prep pre-process alignment data.
79
+ make-adjacent makes sqlitedb of adjacent alignment records.
80
+ toe test of existence of mutation equilibrium.
81
+ teop between branch equivalence of mutation process test
82
+ aeop between loci equivalence of mutation process test
83
+ convergence estimates convergence towards mutation equilibrium.
84
+ make-controls simulate negative and positive controls
85
+ db-summary displays summary information about a db
86
+ extract-pvalues extracts p-values from TOE sqlitedb results
87
+ extract-nabla-c extracts nabla-c from convergence sqlitedb results
88
+ slide generate window sized sub-alignments.
89
+
90
+ ```
91
+ <!-- [[[end]]] -->
92
+
@@ -0,0 +1,54 @@
1
+ [![Coverage Status](https://coveralls.io/repos/github/HuttleyLab/MutationDiseq/badge.svg)](https://coveralls.io/github/HuttleyLab/MutationDiseq)
2
+ [![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)
3
+
4
+ # mdeq: a tool for analysing mutation disequilibrium
5
+
6
+ A manuscript describing the methods will be made available as a preprint soon.
7
+
8
+ ## Installation
9
+
10
+ ```
11
+ $ pip install mdeq
12
+ ```
13
+
14
+ > **Note**
15
+ > `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.
16
+
17
+ ## The available commands
18
+
19
+ <!-- [[[cog
20
+ import cog
21
+ from mdeq import main
22
+ from click.testing import CliRunner
23
+ runner = CliRunner()
24
+ result = runner.invoke(main, ["--help"])
25
+ help = result.output.replace("Usage: main", "Usage: mdeq")
26
+ cog.out(
27
+ "```\n{}\n```".format(help)
28
+ )
29
+ ]]] -->
30
+ ```
31
+ Usage: mdeq [OPTIONS] COMMAND [ARGS]...
32
+
33
+ mdeq: mutation disequilibrium analysis tools.
34
+
35
+ Options:
36
+ --version Show the version and exit.
37
+ --help Show this message and exit.
38
+
39
+ Commands:
40
+ tui Open Textual TUI.
41
+ prep pre-process alignment data.
42
+ make-adjacent makes sqlitedb of adjacent alignment records.
43
+ toe test of existence of mutation equilibrium.
44
+ teop between branch equivalence of mutation process test
45
+ aeop between loci equivalence of mutation process test
46
+ convergence estimates convergence towards mutation equilibrium.
47
+ make-controls simulate negative and positive controls
48
+ db-summary displays summary information about a db
49
+ extract-pvalues extracts p-values from TOE sqlitedb results
50
+ extract-nabla-c extracts nabla-c from convergence sqlitedb results
51
+ slide generate window sized sub-alignments.
52
+
53
+ ```
54
+ <!-- [[[end]]] -->
@@ -0,0 +1,60 @@
1
+ [build-system]
2
+ requires = ["flit_core >=3.2,<4"]
3
+ build-backend = "flit_core.buildapi"
4
+
5
+ [project]
6
+ name = "mdeq"
7
+ authors = [
8
+ { name = "Katherine Caley", email = "katherine.caley@anu.edu.au"},
9
+ { name = "Gavin Huttley", email = "Gavin.Huttley@anu.edu.au"},
10
+ ]
11
+ keywords = ["biology", "genomics", "statistics", "phylogeny", "evolution", "bioinformatics"]
12
+ readme = "README.md"
13
+ license = { file = "LICENSE" }
14
+ requires-python = ">=3.10,<3.14"
15
+ dependencies = [
16
+ "cogent3>=2025.7.10a5",
17
+ "click",
18
+ "numpy",
19
+ "scipy",
20
+ "scitrack",
21
+ "rich",
22
+ "trogon"
23
+ ]
24
+ classifiers = [
25
+ "Development Status :: 5 - Production/Stable",
26
+ "Intended Audience :: Science/Research",
27
+ "License :: OSI Approved :: BSD License",
28
+ "Topic :: Scientific/Engineering :: Bio-Informatics",
29
+ "Topic :: Software Development :: Libraries :: Python Modules",
30
+ "Operating System :: OS Independent",
31
+ "Programming Language :: Python :: 3.10",
32
+ "Programming Language :: Python :: 3.11",
33
+ "Programming Language :: Python :: 3.12",
34
+ "Programming Language :: Python :: 3.13",
35
+ ]
36
+ dynamic = ["version", "description"]
37
+
38
+ [tool.flit.sdist]
39
+ include = ["src/*", "pyproject.toml"]
40
+
41
+ [project.scripts]
42
+ mdeq = "mdeq:main"
43
+
44
+ [project.optional-dependencies]
45
+ test = [
46
+ "pytest",
47
+ "pytest-cov",
48
+ "pytest-xdist",
49
+ "nox",
50
+ ]
51
+ dev = [
52
+ "cogapp",
53
+ "docformatter",
54
+ "mdeq[test]",
55
+ "ruff==0.12.8",
56
+ ]
57
+
58
+ [tool.pytest.ini_options]
59
+ addopts = ["--strict-config", "-ra"]
60
+ testpaths = "tests"