Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"title": "DotMatch: deterministic known-target short-DNA assignment for sequencing workflows",
"upload_type": "software",
"version": "0.7.0",
"version": "0.8.0",
"conceptdoi": "10.5281/zenodo.20541628",
"creators": [
{
Expand Down
19 changes: 9 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
# Changelog

## 0.7.0 — 2026-10-03

- Add a guide-counter-compatible counting path, precision boundary fixes, and an audited five-repeat comparison with matching counts.
- Add experimental joint gene-level inference and whole-gene control calibration to CRISPRWorks Fit, with convergence and attainable-FDR diagnostics.
- Stage Fit output bundles, verify consumed inputs, prevent overlapping publication, and reject malformed MLE counts before fitting.
- Add first-run tutorials, scientific audit findings, benchmark graphs and scoped comparison callouts.
- Keep biological validation limitations explicit; experimental Fit is not evidence of general scientific superiority.


All notable user-facing changes are tracked here. Public statements in release notes must stay aligned with `docs/scientific-claims.md`.

## Unreleased
## 0.8.0 — 2026-10-31

- Add `dotmatch mcp`, a dependency-free local stdio MCP server exposing `route_task`, `count_targets`, `demux_barcodes`, `audit_targets`, `edit_distance` and the six assay tools to Claude Code, Codex, Cursor and other MCP clients.
- Add a Claude Code plugin marketplace (`/plugin install dotmatch --marketplace dnncha/dotmatch`) bundling the MCP server and a routing skill.
Expand All @@ -36,6 +27,14 @@ All notable user-facing changes are tracked here. Public statements in release n
- Update the hosted demo's fallback install from DotMatch 0.6.3 to the current
0.6.4 release.

## 0.7.0 — 2026-10-03

- Add a guide-counter-compatible counting path, precision boundary fixes, and an audited five-repeat comparison with matching counts.
- Add experimental joint gene-level inference and whole-gene control calibration to CRISPRWorks Fit, with convergence and attainable-FDR diagnostics.
- Stage Fit output bundles, verify consumed inputs, prevent overlapping publication, and reject malformed MLE counts before fitting.
- Add first-run tutorials, scientific audit findings, benchmark graphs and scoped comparison callouts.
- Keep biological validation limitations explicit; experimental Fit is not evidence of general scientific superiority.

## 0.6.4 - 2026-09-29

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors:
orcid: "https://orcid.org/0009-0003-5012-7229"
repository-code: "https://github.com/dnncha/dotmatch"
license: Apache-2.0
version: "0.7.0"
version: "0.8.0"
doi: "10.5281/zenodo.23118107"
abstract: "DotMatch is a deterministic known-target short-DNA assignment engine for CRISPR guide counting, barcode demultiplexing, and fixed-target FASTQ workflows."
keywords:
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ LABEL org.opencontainers.image.title="DotMatch" \
org.opencontainers.image.source="https://github.com/dnncha/dotmatch" \
org.opencontainers.image.url="https://dotmatch.readthedocs.io/" \
org.opencontainers.image.documentation="https://dotmatch.readthedocs.io/" \
org.opencontainers.image.version="0.7.0" \
org.opencontainers.image.version="0.8.0" \
org.opencontainers.image.licenses="Apache-2.0" \
org.opencontainers.image.authors="Donncha O'Toole"
COPY --from=build /wheels /wheels
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ basecaller, cell/UMI pipeline or gene-level hit-calling package.

## Install

Release 0.7.0 is published on PyPI and GHCR. It includes the six `dotmatch agent` tools
Release 0.8.0 is published on PyPI (GHCR has 0.7.0). It includes the six `dotmatch agent` tools
described below:

```bash
python3 -m pip install dotmatch==0.7.0
python3 -m pip install dotmatch==0.8.0
dotmatch --version
```

Expand Down Expand Up @@ -143,10 +143,10 @@ best-distance Hamming assignment using the same windows in **one FASTQ pass**.
It produces three count matrices, per-guide deltas, read-state transitions,
checksums and a self-contained HTML report. It never selects a policy for you.

Run the included synthetic example from a checkout of the v0.7.0 release:
Run the included synthetic example from a checkout of the v0.8.0 release:

```bash
python3 -m pip install dotmatch==0.7.0
python3 -m pip install dotmatch==0.8.0
dotmatch sensitivity \
--targets examples/assignment_sensitivity/targets.tsv \
--reads examples/assignment_sensitivity/reads.fastq \
Expand All @@ -161,7 +161,7 @@ This is sensitivity analysis, not an estimate of biological accuracy.

[Explore the interactive review example](https://dnncha.github.io/dotmatch/assignment-sensitivity/)
without installing anything. The example uses the public nine-read synthetic fixture.
The interactive assignment review is published on the DotMatch 0.7.0 site.
The interactive assignment review is published on the DotMatch 0.8.0 site.
The installed `dotmatch sensitivity` command continues to write its static
report. The synthetic fixture demonstrates software behavior, not biological
accuracy.
Expand Down Expand Up @@ -243,8 +243,8 @@ reliability contract is in
Add DotMatch as a local MCP server in Claude Code, Codex, Cursor or any MCP client:

```bash
claude mcp add dotmatch -- uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp
codex mcp add dotmatch -- uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp
claude mcp add dotmatch -- uvx dotmatch mcp
codex mcp add dotmatch -- uvx dotmatch mcp
```

Claude Code users can install the plugin, which bundles the MCP server and a routing skill:
Expand All @@ -255,7 +255,7 @@ Claude Code users can install the plugin, which bundles the MCP server and a rou

On older Claude Code versions, run `/plugin marketplace add dnncha/dotmatch` and then `/plugin install dotmatch@dotmatch`. Other MCP clients use `{"mcpServers": {"dotmatch": {"command": "uvx", "args": ["--from", "git+https://github.com/dnncha/dotmatch", "dotmatch", "mcp"]}}}`. With DotMatch already installed from source, `dotmatch mcp` serves the same tools.

The server exposes `route_task`, `count_targets`, `demux_barcodes`, `audit_targets` and `edit_distance` for known-window work, plus the six assay tools above for reviewed CRISPR and Perturb-seq runs. Every tool runs locally, takes structured arguments only, refuses to overwrite existing outputs, and returns the JSON envelope as MCP structured content. `dotmatch mcp` ships on the main branch ahead of the next PyPI release, so the commands above install from source and need a C compiler.
The server exposes `route_task`, `count_targets`, `demux_barcodes`, `audit_targets` and `edit_distance` for known-window work, plus the six assay tools above for reviewed CRISPR and Perturb-seq runs. Every tool runs locally, takes structured arguments only, refuses to overwrite existing outputs, and returns the JSON envelope as MCP structured content. `dotmatch mcp` ships in DotMatch 0.8.0 and later.

The six structured agent tools are included in release 0.5.0:

Expand Down
6 changes: 3 additions & 3 deletions agent-capabilities.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://dnncha.github.io/dotmatch/agent-capabilities.schema.json",
"schema_version": "1.1",
"generated_for_version": "0.7.0",
"generated_for_version": "0.8.0",
"project": {
"name": "DotMatch",
"package": "dotmatch",
Expand All @@ -27,7 +27,7 @@
]
},
"install": {
"recommended": "python3 -m pip install dotmatch==0.7.0",
"recommended": "python3 -m pip install dotmatch==0.8.0",
"verify": "dotmatch --version",
"platforms": [
"Linux x86_64 or aarch64 with glibc or musl",
Expand Down Expand Up @@ -295,7 +295,7 @@
"agent_tools_schema": "https://dnncha.github.io/dotmatch/agent-tools.schema.json",
"codex_skill": "https://github.com/dnncha/dotmatch/tree/main/extensions/codex/dotmatch-agent",
"mcp_server": "dotmatch mcp",
"mcp_server_no_install": "uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp",
"mcp_server_no_install": "uvx dotmatch mcp",
"claude_plugin": "https://github.com/dnncha/dotmatch/tree/main/extensions/claude/dotmatch"
}
}
2 changes: 1 addition & 1 deletion agent-capabilities.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
"agent_tools_schema": {"type": "string", "format": "uri"},
"codex_skill": {"type": "string", "format": "uri"},
"mcp_server": {"const": "dotmatch mcp"},
"mcp_server_no_install": {"const": "uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp"},
"mcp_server_no_install": {"const": "uvx dotmatch mcp"},
"claude_plugin": {"type": "string", "format": "uri"}
}
}
Expand Down
2 changes: 1 addition & 1 deletion agent-reference-crispr.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"schema_version": "1.0",
"tool_contract_version": "1.0",
"dotmatch_version": "0.7.0",
"dotmatch_version": "0.8.0",
"tool": "review_assay",
"status": "failed",
"exit_code": 2,
Expand Down
2 changes: 1 addition & 1 deletion agent-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://dnncha.github.io/dotmatch/agent-tools.schema.json",
"schema_version": "1.0",
"tool_contract_version": "1.0",
"generated_for_version": "0.7.0",
"generated_for_version": "0.8.0",
"transport": {
"input": "one JSON object supplied by file, stdin, or the Python API",
"output": "one JSON envelope on stdout or as a Python dictionary",
Expand Down
2 changes: 1 addition & 1 deletion app/site-metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const siteUrl = (process.env.NEXT_PUBLIC_SITE_URL ?? "https://dnncha.gith
export const basePath = (process.env.NEXT_PUBLIC_BASE_PATH ?? "").replace(/\/+$/, "");
export const docsUrl = "https://dotmatch.readthedocs.io/en/latest/";
export const repoUrl = "https://github.com/dnncha/dotmatch";
export const publishedVersion = "0.7.0";
export const publishedVersion = "0.8.0";
export const conceptDoi = "https://doi.org/10.5281/zenodo.20541628";
export function sitePath(path = ""): string {
const clean = path.replace(/^\/+|\/+$/g, "");
Expand Down
4 changes: 2 additions & 2 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
"issueTracker": "https://github.com/dnncha/dotmatch/issues",
"license": "https://spdx.org/licenses/Apache-2.0",
"identifier": "https://doi.org/10.5281/zenodo.20541628",
"version": "0.7.0",
"softwareVersion": "0.7.0",
"version": "0.8.0",
"softwareVersion": "0.8.0",
"programmingLanguage": [
"C",
"Python",
Expand Down
6 changes: 3 additions & 3 deletions docs/agent-capabilities.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://dnncha.github.io/dotmatch/agent-capabilities.schema.json",
"schema_version": "1.1",
"generated_for_version": "0.7.0",
"generated_for_version": "0.8.0",
"project": {
"name": "DotMatch",
"package": "dotmatch",
Expand All @@ -27,7 +27,7 @@
]
},
"install": {
"recommended": "python3 -m pip install dotmatch==0.7.0",
"recommended": "python3 -m pip install dotmatch==0.8.0",
"verify": "dotmatch --version",
"platforms": [
"Linux x86_64 or aarch64 with glibc or musl",
Expand Down Expand Up @@ -295,7 +295,7 @@
"agent_tools_schema": "https://dnncha.github.io/dotmatch/agent-tools.schema.json",
"codex_skill": "https://github.com/dnncha/dotmatch/tree/main/extensions/codex/dotmatch-agent",
"mcp_server": "dotmatch mcp",
"mcp_server_no_install": "uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp",
"mcp_server_no_install": "uvx dotmatch mcp",
"claude_plugin": "https://github.com/dnncha/dotmatch/tree/main/extensions/claude/dotmatch"
}
}
2 changes: 1 addition & 1 deletion docs/agent-capabilities.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
"agent_tools_schema": {"type": "string", "format": "uri"},
"codex_skill": {"type": "string", "format": "uri"},
"mcp_server": {"const": "dotmatch mcp"},
"mcp_server_no_install": {"const": "uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp"},
"mcp_server_no_install": {"const": "uvx dotmatch mcp"},
"claude_plugin": {"type": "string", "format": "uri"}
}
}
Expand Down
10 changes: 5 additions & 5 deletions docs/agent-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ JSON envelope to stdout and progress or diagnostics to stderr. The Python API
exposes the same contract through `dotmatch.agent_tools.list_tools()` and
`dotmatch.agent_tools.invoke_tool()`.

Version 0.7.0 is verified on PyPI and GHCR; verify other channels separately. This six-tool interface is included in release 0.7.0.
Version 0.8.0 is verified on PyPI (GHCR has 0.7.0); verify other channels separately. This six-tool interface is included in release 0.8.0.
Check `dotmatch --version` before following this route. If a channel provides
an older package, use the ordinary CLI commands or `dotmatch capabilities
--json` until that channel reaches 0.7.0.
--json` until that channel reaches 0.8.0.

The canonical contract and schema are also published as
[`agent-tools.json`](https://dnncha.github.io/dotmatch/agent-tools.json) and
Expand Down Expand Up @@ -179,8 +179,8 @@ before broadening a workflow or a claim.
## MCP server and Claude Code plugin

```bash
claude mcp add dotmatch -- uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp
codex mcp add dotmatch -- uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp
claude mcp add dotmatch -- uvx dotmatch mcp
codex mcp add dotmatch -- uvx dotmatch mcp
```

Claude Code users can install the plugin, which bundles the MCP server and a routing skill:
Expand All @@ -191,4 +191,4 @@ Claude Code users can install the plugin, which bundles the MCP server and a rou

On older Claude Code versions, run `/plugin marketplace add dnncha/dotmatch` and then `/plugin install dotmatch@dotmatch`. Other MCP clients use `{"mcpServers": {"dotmatch": {"command": "uvx", "args": ["--from", "git+https://github.com/dnncha/dotmatch", "dotmatch", "mcp"]}}}`. With DotMatch already installed from source, `dotmatch mcp` serves the same tools.

The server exposes `route_task`, `count_targets`, `demux_barcodes`, `audit_targets` and `edit_distance` for known-window work, plus the six assay tools above for reviewed CRISPR and Perturb-seq runs. Every tool runs locally, takes structured arguments only, refuses to overwrite existing outputs, and returns the JSON envelope as MCP structured content. `dotmatch mcp` ships on the main branch ahead of the next PyPI release, so the commands above install from source and need a C compiler.
The server exposes `route_task`, `count_targets`, `demux_barcodes`, `audit_targets` and `edit_distance` for known-window work, plus the six assay tools above for reviewed CRISPR and Perturb-seq runs. Every tool runs locally, takes structured arguments only, refuses to overwrite existing outputs, and returns the JSON envelope as MCP structured content. `dotmatch mcp` ships in DotMatch 0.8.0 and later.
2 changes: 1 addition & 1 deletion docs/agent-reference-crispr.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"schema_version": "1.0",
"tool_contract_version": "1.0",
"dotmatch_version": "0.7.0",
"dotmatch_version": "0.8.0",
"tool": "review_assay",
"status": "failed",
"exit_code": 2,
Expand Down
2 changes: 1 addition & 1 deletion docs/agent-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://dnncha.github.io/dotmatch/agent-tools.schema.json",
"schema_version": "1.0",
"tool_contract_version": "1.0",
"generated_for_version": "0.7.0",
"generated_for_version": "0.8.0",
"transport": {
"input": "one JSON object supplied by file, stdin, or the Python API",
"output": "one JSON envelope on stdout or as a Python dictionary",
Expand Down
2 changes: 1 addition & 1 deletion docs/crisprworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The broader Review tool is planned. The desktop Workbench is developed separatel
Install the published package and use its existing command:

```bash
python3 -m pip install dotmatch==0.7.0
python3 -m pip install dotmatch==0.8.0
dotmatch --version
dotmatch demo --out-dir first-run/
```
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ python3 -m pip install dotmatch
dotmatch --version
```

Release 0.7.0 is published on PyPI and GHCR and includes the six `dotmatch agent`
tools described below. Confirm that `dotmatch --version` reports 0.7.0 before
Release 0.8.0 is published on PyPI (GHCR has 0.7.0) and includes the six `dotmatch agent`
tools described below. Confirm that `dotmatch --version` reports 0.8.0 before
using them. Bioconda and BioContainers may lag PyPI; check the installed
version when using those channels.

Expand Down
14 changes: 7 additions & 7 deletions docs/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Each invocation accepts a JSON object, returns one stable JSON envelope on stdou
## MCP server

```bash
claude mcp add dotmatch -- uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp
codex mcp add dotmatch -- uvx --from git+https://github.com/dnncha/dotmatch dotmatch mcp
claude mcp add dotmatch -- uvx dotmatch mcp
codex mcp add dotmatch -- uvx dotmatch mcp
```

Claude Code users can install the plugin, which bundles the MCP server and a routing skill:
Expand All @@ -35,20 +35,20 @@ Claude Code users can install the plugin, which bundles the MCP server and a rou

On older Claude Code versions, run `/plugin marketplace add dnncha/dotmatch` and then `/plugin install dotmatch@dotmatch`. Other MCP clients use `{"mcpServers": {"dotmatch": {"command": "uvx", "args": ["--from", "git+https://github.com/dnncha/dotmatch", "dotmatch", "mcp"]}}}`. With DotMatch already installed from source, `dotmatch mcp` serves the same tools.

The server exposes `route_task`, `count_targets`, `demux_barcodes`, `audit_targets` and `edit_distance` for known-window work, plus the six assay tools above for reviewed CRISPR and Perturb-seq runs. Every tool runs locally, takes structured arguments only, refuses to overwrite existing outputs, and returns the JSON envelope as MCP structured content. `dotmatch mcp` ships on the main branch ahead of the next PyPI release, so the commands above install from source and need a C compiler.
The server exposes `route_task`, `count_targets`, `demux_barcodes`, `audit_targets` and `edit_distance` for known-window work, plus the six assay tools above for reviewed CRISPR and Perturb-seq runs. Every tool runs locally, takes structured arguments only, refuses to overwrite existing outputs, and returns the JSON envelope as MCP structured content. `dotmatch mcp` ships in DotMatch 0.8.0 and later.

## Install and verify

Version 0.7.0 is published and verified on PyPI and GHCR. Bioconda and
BioContainers 0.7.0 still require upstream submission and public verification.
Version 0.8.0 is published and verified on PyPI (GHCR has 0.7.0). Bioconda and
BioContainers 0.8.0 still require upstream submission and public verification.

Linux x86_64 and macOS 11 or newer:

```bash
mkdir -p smoke-output
python3 -m venv .venv
. .venv/bin/activate
python3 -m pip install dotmatch==0.7.0
python3 -m pip install dotmatch==0.8.0
dotmatch --version
```

Expand Down Expand Up @@ -226,7 +226,7 @@ After cloning this repository, this recipe installs the release into a new virtu
```bash
python3 -m venv .venv
. .venv/bin/activate
python3 -m pip install dotmatch==0.7.0
python3 -m pip install dotmatch==0.8.0
dotmatch count \
--targets demo-data/crispr_guides.tsv \
--reads demo-data/reads.fastq \
Expand Down
Loading
Loading