Skip to content

Commit 800c3d8

Browse files
authored
Bump to v1.0.0 (first stable release; metadata maintenance) (#9)
Promotes dcebe to 1.0.0 to signal API stability. The MATLAB reference implementation has been published since 2018; the Python port was developed in 2026 and the public API (estimate_bat) is unchanged from the 0.1.0 dev release. Aligns pyproject.toml, python/dcebe/__init__.py __version__, and CITATION.cff version/date-released. Adds CHANGELOG.md (was missing). No algorithmic changes.
1 parent a3f50fe commit 800c3d8

4 files changed

Lines changed: 47 additions & 4 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Changelog
2+
3+
All notable changes to the `dcebe` Python package are documented here.
4+
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
5+
and the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) layout.
6+
7+
The MATLAB reference implementation is tracked separately in this same
8+
repo's git history; algorithmic semantics are unchanged across the port.
9+
10+
## [Unreleased]
11+
12+
## [1.0.0] — 2026-05-11
13+
14+
First stable release.
15+
16+
The MATLAB reference DCEBE has been published since 2018 (paper:
17+
Bendinger, Debus, Glowa, Karger, Peter, Storath, *Bolus arrival time
18+
estimation in dynamic contrast-enhanced MRI of small animals based on
19+
spline models*, Physics in Medicine & Biology 64(4), 2019). The Python
20+
re-implementation in this repository was developed in 2026 as a port
21+
of the MATLAB code; the user-facing API (`estimate_bat`) is unchanged
22+
from the 0.1.0 dev release.
23+
24+
### Added
25+
26+
- Python re-implementation of `DCEBE_estimateBAT.m` as `estimate_bat`,
27+
returning an `EstimateResult` dataclass with 1-based MATLAB-compatible
28+
sample units.
29+
- `pip install dcebe` from PyPI. Pure Python (NumPy + SciPy); no
30+
compiled wheels, no Rust, no MATLAB runtime required.
31+
- Auto-create GitHub Release on tag push (alongside PyPI publish).
32+
- `CITATION.cff` with `version` and `date-released` fields.
33+
- README harmonised with the lab-repo family (badge block,
34+
Quickstart-first ordering, "See also" section linking the five
35+
sibling repos, License footer).
36+
37+
### Changed
38+
39+
- `LICENSE` cleaned up: non-standard "if this code is used in any
40+
scientific publication, the following paper shall be cited" clause
41+
removed. The LICENSE file is now pure Apache-2.0 matching the
42+
declaration in `CITATION.cff` and `pyproject.toml`. The citation
43+
request lives in `CITATION.cff` and the README.

‎CITATION.cff‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
cff-version: 1.2.0
22
message: "If you use this software, please cite both the software and the associated paper below."
33
title: "DCEBE: Bolus arrival time estimation for DCE-MRI signals"
4-
version: 0.1.0
5-
date-released: 2026-05-08
4+
version: 1.0.0
5+
date-released: 2026-05-11
66
abstract: "Reference MATLAB implementation of a spline-based model for estimating the bolus arrival time of dynamic contrast-enhanced MRI (DCE-MRI) signals. Particularly intended for signals without a fast upslope, as commonly seen in small-animal data. Parameters are selected via generalised cross-validation."
77
type: software
88
url: "https://github.com/mstorath/DCEBE"

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "dcebe"
7-
version = "0.1.0"
7+
version = "1.0.0"
88
description = "Bolus arrival time estimation for DCE-MRI signals via spline models with generalized cross-validation"
99
license = { file = "LICENSE" }
1010
authors = [

‎python/dcebe/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818
from ._solve import EstimateResult, estimate_bat
1919

2020
__all__ = ["EstimateResult", "estimate_bat"]
21-
__version__ = "0.1.0"
21+
__version__ = "1.0.0"

0 commit comments

Comments
 (0)