Skip to content

Commit 770e4d6

Browse files
committed
Release version 0.17.0
1 parent 891f16b commit 770e4d6

32 files changed

+3665
-280
lines changed

.github/workflows/forward.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,27 @@ jobs:
1616
script: |
1717
const originalIssue = context.payload.issue;
1818
const body = originalIssue.body;
19-
19+
2020
if (body.includes('Repost: Yes')) {
2121
// Forward to org repo
2222
const cleanBody = body.replace(/Repost:\s*(Yes|No)\s*\n?/gi, '').trim();
23-
23+
2424
const newIssue = await github.rest.issues.create({
2525
owner: 'rges-pit',
2626
repo: 'microlens-submit',
2727
title: originalIssue.title,
2828
body: cleanBody + '\n\n---\n*Originally submitted via help form*',
2929
labels: ['type:help', 'source:web-form']
3030
});
31-
31+
3232
// Comment with forward link
3333
await github.rest.issues.createComment({
3434
owner: context.repo.owner,
3535
repo: context.repo.repo,
3636
issue_number: originalIssue.number,
3737
body: `✅ Forwarded to: ${newIssue.data.html_url}`
3838
});
39-
39+
4040
} else if (body.includes('Repost: No')) {
4141
// Just add a comment explaining why it's being closed
4242
await github.rest.issues.createComment({
@@ -46,7 +46,7 @@ jobs:
4646
body: '❌ Not forwarded as requested. Closing help form issue.'
4747
});
4848
}
49-
49+
5050
// Close the original issue in both cases
5151
await github.rest.issues.update({
5252
owner: context.repo.owner,

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.17.0] - 2026-02-04
9+
10+
### Added
11+
- **Physical Parameters**: Added 24 physical parameters (Mtot, M1-M4, D_L, D_S, thetaE, piE components, mu_rel components, phi) to parameter spec
12+
- **Physical Parameter Validation**: Comprehensive validation including mass consistency checks, vector magnitude verification, distance constraints, and unit confusion warnings
13+
- **Uncertainty Metadata**: Added three new Solution fields:
14+
- `uncertainty_method`: Method used to derive uncertainties (mcmc_posterior, fisher_matrix, bootstrap, propagation, inference, literature, other)
15+
- `confidence_level`: Confidence level for uncertainties (default: 0.68 for 1-sigma)
16+
- `physical_parameter_uncertainties`: Uncertainties for physical parameters (symmetric or asymmetric)
17+
- **CLI Options**: Added `--physical-param-uncertainty`, `--uncertainty-method`, and `--confidence-level` options to `add-solution` command
18+
- **Tests**: Added 3 new comprehensive BIC calculation tests verifying parameter counting
19+
- **Version Management**: Enhanced `bump_version.py` to update and validate `parameter_spec.yaml` (includes drift check)
20+
21+
### Fixed
22+
- **BIC Calculation Bug**: Fixed critical bug where BIC calculation counted ALL parameters including metadata (t_ref, limb_darkening_coeffs) and physical parameters (Mtot, D_L, etc.) as "free parameters". Now correctly counts only fitted model parameters using new `count_model_parameters()` function. This affects relative probability calculations during export and solution comparison.
23+
24+
### Changed
25+
- Physical parameters now validated with `validate_physical_parameters()` automatically when present
26+
- Solution metadata validation now includes uncertainty metadata checks
27+
- BIC calculation in `submission.py` and `validation.py` now uses `count_model_parameters()` instead of `len(s.parameters)`
28+
29+
### Documentation
30+
- Added comprehensive examples of physical parameters and uncertainty metadata to tutorial and usage examples
31+
- Tutorial emphasizes uncertainties are **optional but strongly recommended** for evaluation readiness
32+
- Created `PHYSICAL_PARAMS_SUMMARY.md` with complete implementation guide
33+
34+
## [Unreleased]
35+
836
## [0.16.5] - 2026-02-04
937

1038
### Fixed

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
cff-version: 1.2.0
22
message: "If you use microlens-submit, please cite it as below."
33
title: "microlens-submit"
4-
version: "0.16.5"
4+
version: "0.17.0"
55
authors:
66
- family-names: Malpas
77
given-names: Amber
88
url: "https://github.com/AmberLee2427/microlens-submit"
9-
doi: "10.5281/zenodo.18246117"
9+
doi: "10.5281/zenodo.18488304"

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,15 +160,15 @@ import this file directly.
160160

161161
Bibtex:
162162
```
163-
@software{malpas_2025_18246117,
163+
@software{malpas_2025_18488304,
164164
author = {Malpas, Amber},
165165
title = {microlens-submit},
166166
month = oct,
167167
year = 2025,
168168
publisher = {Zenodo},
169169
version = {v0.16.3},
170-
doi = {10.5281/zenodo.18246117},
171-
url = {https://doi.org/10.5281/zenodo.18246117},
170+
doi = {10.5281/zenodo.18488304},
171+
url = {https://doi.org/10.5281/zenodo.18488304},
172172
}
173173
```
174174

RELEASE_NOTES.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
1-
# microlens-submit v0.16.5 Release Notes
1+
# microlens-submit v0.17.0 Release Notes
22

33
**Release Date:** 2026-02-04
44

55
## Changelog
66

7-
## [0.16.5] - 2026-02-04
7+
## [0.17.0] - 2026-02-04
8+
9+
### Added
10+
- **Physical Parameters**: Added 24 physical parameters (Mtot, M1-M4, D_L, D_S, thetaE, piE components, mu_rel components, phi) to parameter spec
11+
- **Physical Parameter Validation**: Comprehensive validation including mass consistency checks, vector magnitude verification, distance constraints, and unit confusion warnings
12+
- **Uncertainty Metadata**: Added three new Solution fields:
13+
- `uncertainty_method`: Method used to derive uncertainties (mcmc_posterior, fisher_matrix, bootstrap, propagation, inference, literature, other)
14+
- `confidence_level`: Confidence level for uncertainties (default: 0.68 for 1-sigma)
15+
- `physical_parameter_uncertainties`: Uncertainties for physical parameters (symmetric or asymmetric)
16+
- **CLI Options**: Added `--physical-param-uncertainty`, `--uncertainty-method`, and `--confidence-level` options to `add-solution` command
17+
- **Tests**: Added 3 new comprehensive BIC calculation tests verifying parameter counting
18+
- **Version Management**: Enhanced `bump_version.py` to update and validate `parameter_spec.yaml` (includes drift check)
819

920
### Fixed
10-
- Dossier assets are now copied into the dossier output and linked with URL-safe relative paths,
11-
improving image loading in Roman Research Nexus and similar environments.
12-
- Event data, plots, and posteriors now resolve reliably when paths include spaces or nested folders.
21+
- **BIC Calculation Bug**: Fixed critical bug where BIC calculation counted ALL parameters including metadata (t_ref, limb_darkening_coeffs) and physical parameters (Mtot, D_L, etc.) as "free parameters". Now correctly counts only fitted model parameters using new `count_model_parameters()` function. This affects relative probability calculations during export and solution comparison.
22+
23+
### Changed
24+
- Physical parameters now validated with `validate_physical_parameters()` automatically when present
25+
- Solution metadata validation now includes uncertainty metadata checks
26+
- BIC calculation in `submission.py` and `validation.py` now uses `count_model_parameters()` instead of `len(s.parameters)`
27+
28+
### Documentation
29+
- Added comprehensive examples of physical parameters and uncertainty metadata to tutorial and usage examples
30+
- Tutorial emphasizes uncertainties are **optional but strongly recommended** for evaluation readiness
31+
- Created `PHYSICAL_PARAMS_SUMMARY.md` with complete implementation guide

TODO

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,17 @@
1919
- [x] auto populate hardware info
2020
- [x] ".001" gets interpreted as a string
2121
- [x] nexus init gives hardware warning and it doesn't need to
22-
- [ ] nexus dosiers (with submission in /teams/*) not displaying images (problem in AAS workshop notebooks)
22+
- [x] nexus dosiers (with submission in /teams/*) not displaying images (problem in AAS workshop notebooks)
2323
- [x] "Experienced' tier not "Advanced"
24-
- [ ] validate physical parameters (blocked)
24+
- [x] validate physical parameters
2525
- [x] "piEN (instead of piEN)" when piEN was missing
26-
- [ ] additional model types (blocked)
26+
- [x] additional model types
2727
- [x] git and submission in different locations (add git_dir)
2828
- [x] Windows build in workflow
2929
- [x] Release Workflow
3030
- [x] Wheel build CI
3131
- [x] Unhelpful error when band not supoplied but a flux value is
32+
- [ ] What the fuck do we do about uncertainties?
3233

3334

3435
## Conda Forge

conda/recipe/meta.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% set name = "microlens-submit" %}
22
{% set filename_name = name | replace("-", "_") %}
3-
{% set version = "0.16.5" %}
3+
{% set version = "0.17.0" %}
44
{% set python_min = "3.10" %}
55

66
# NOTE: This recipe is the source of truth for conda-forge. Edit it here in

0 commit comments

Comments
 (0)