Skip to content

Commit b3de6c8

Browse files
committed
release: 2.3.1 — logo + author-metadata + tooling/docs
- Add the GenAIRR logo (transparent background) and surface it at the top of the README so it renders on the PyPI project page. - Bump version 2.3.0 -> 2.3.1; add the CHANGELOG entry. This release carries the correct PyPI author metadata (Thomas Konstantinovsky first), the tools/build_imgt_configs.py maintainer tool, __all__ on the public authoring modules, the codebase reorganization, and the bundled-cartridge distribution-provenance docs note. No public API or simulation-behaviour changes.
1 parent 2b6f545 commit b3de6c8

4 files changed

Lines changed: 32 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
All notable changes to GenAIRR are documented here.
44

5+
## [2.3.1] - 2026-07-05
6+
7+
Maintenance release. No public API or simulation-behaviour changes.
8+
9+
### Packaging
10+
- Correct the PyPI author metadata (Thomas Konstantinovsky listed first).
11+
- Add the GenAIRR logo to the README / PyPI project page.
12+
13+
### Added
14+
- `tools/build_imgt_configs.py` — a first-class maintainer tool that builds
15+
structural cartridges from IMGT V-QUEST germline FASTA via
16+
`ReferenceCartridgeBuilder`.
17+
- `__all__` on the documented public authoring modules (`reference_models`,
18+
`reference_rules`, `cartridge_builder`, `genotype_priors`, `cohort`).
19+
20+
### Changed
21+
- Large behaviour-preserving internal reorganization: several god-files split
22+
into focused packages/modules (`experiment.py`, `_cartridge_estimators`,
23+
`_compiled`, `result`, `genotype`, `utilities/visualize`, and the Rust
24+
`airr_record/validate.rs`), plus dead-code and duplicate-module removal. No
25+
user-visible import paths changed.
26+
27+
### Documentation
28+
- Clarify that only the human IGH/IGK/IGL and TCRB cartridges carry
29+
data-derived distributions; every other bundled cartridge uses
30+
uniform/placeholder parameters (with guidance on fitting real ones).
31+
532
## [2.3.0] - 2026-06-18
633

734
### Added - Per-individual diploid genotypes

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/MuteJester/GenAIRR/master/site_docs/assets/genairr_logo.png" alt="GenAIRR" width="200">
3+
</p>
4+
15
<h1 align="center">GenAIRR</h1>
26

37
<p align="center">

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ build-backend = "maturin"
1515

1616
[project]
1717
name = "GenAIRR"
18-
version = "2.3.0"
18+
version = "2.3.1"
1919
description = "Synthetic immune-receptor-sequence simulator for benchmarking alignment models and sequence analysis."
2020
readme = "README.md"
2121
requires-python = ">=3.9"

site_docs/assets/genairr_logo.png

689 KB
Loading

0 commit comments

Comments
 (0)