Releases: sarthaktexas/cryoem-halfmap-qc
Releases · sarthaktexas/cryoem-halfmap-qc
Release list
v0.7.0
Summary
Lean installable package for structural biologists: pip install cryoem-halfmap-qc → halfmap-qc CLI.
- Reliability path: windowed smoothness on z-scored half-map average ρ →
reliability_score(ranked) andbuild_zoneMRCs - Package boundary: thesis-only code (ROC/AUC, metric comparison, cohort figures, TV curvature) moved to
thesis/— not shipped on PyPI - Naming: production metric is
reliability_smoothness/windowed_smoothness(legacyreliability_H_reproCSV columns still read) - Style:
style/palette.py+style/figures.pyreplacenature.py/thesis_palette.py
Install
pip install cryoem-halfmap-qc
halfmap-qc # interactive: two half-maps → reliability + build-zone MRCsBreaking changes
- Removed public exports for T/L/H mechanics,
placement_utility,tv_curvature, and related thesis modules fromcryoem_mrc - Q-score validation in the package no longer depends on
metric_comparison/residue_metrics.csv(uses halfmap reliability bundle instead)
v0.6.0
halfmap-qc (interactive)
- Prompt for auto or manual contour after loading half-maps
- Estimate masked global FSC resolution and warn when outside the model-building band (>4 Å)
- Reuse loaded maps so preflight and pipeline share one read
Thesis validation tooling
- Builder-omission ROC (
cryoem_mrc/builder_omission.py,scripts/run_placement_builder_omission_roc.py): classify built Cα vs sequence-gap proxy sites - Placement Q ROC (
scripts/run_placement_q_roc.py) - Expanded Q-score validation and cross-metric summary scripts
- Placement utility helpers for Q ROC predictors and cohort paths
Install
pip install cryoem-halfmap-qc==0.6.0Publishing to PyPI is triggered automatically by this GitHub release.
v0.5.3
Summary
halfmap-qc reliabilitynow writes only two MRC overlays:{label}_reliability.mrcand{label}_build_zones.mrc- Removed PNG/PDF figures,
reliability.npz,run_metadata.json, and the--halfmap-npzrequirement from the reliability step halfmap-qc analyzeno longer writessummary.txtor the default histogram PNG (still produceshalfmap_metrics.npzandcorrelations.csv)- B-factor validation and metric comparison moved to repo-local
thesis/(not installed from PyPI)
Install
pip install -U cryoem-halfmap-qcMinimal pipeline
halfmap-qc features map.mrc --out features.npz --float32
halfmap-qc reliability \
--reference ref.map --half1 half1.map --half2 half2.map \
--features features.npz --contour CONTOUR --out-dir reliability_outAnalyze is optional if you only need the reliability and build-zone MRCs.
v0.5.1
Fixes
halfmap-qc features map.mrc—main()now accepts forwarded argv (fixesTypeError: main() takes 0 positional arguments but 1 was given).- ARC sbatch template —
scripts/halfmap_qc_cluster.sbatch.exampleruns features → analyze → reliability with per-step failure guards.
Docs
- README includes TUI screenshot and sbatch instructions.
pip install -U cryoem-halfmap-qcv0.5.0
Summary
- Path-based CLI —
features,analyze, andreliabilityrequire explicit map paths (no thesis defaults or cohort subcommands). - Rich interactive TUI — colored menu, ASCII banner, guided full pipeline.
halfmap_metrics— replaces the oldhalf_map_repromodule naming; MRC exports usehalfmap_prefix.- Slim README — PyPI install only.
- CI fix — CLI help test updated for current install text.
Install
pip install cryoem-halfmap-qc
halfmap-qcBreaking changes
- Removed
halfmap-qc cohort/cohort-idsfrom the installed CLI (thesis batch:python scripts/run_cohort_pipeline.py). reliabilityandanalyzerequire--contourand all map paths explicitly.
v0.3.3
Install
pip install cryoem-halfmap-qcChanges
- README rewritten for public/PyPI use (no thesis-only sections)
- PyPI/GitHub link metadata:
Homepage,Documentation,Issues,ChangelogURLs - Citation metadata updated to v0.3.3
After install, the package should appear in the GitHub repo sidebar under Packages once PyPI indexes the new release (may take a few minutes).
v0.3.2 — halfmap-qc CLI (PyPI)
Install
pip install cryoem-halfmap-qc
halfmap-qc --versionSame as v0.3.1 plus a PyPI metadata fix (removed git URL from optional dependencies).
Highlights
halfmap-qcCLI — features, analyze, reliability, cohort, cohort-ids, help, interactive TUI- Cohort drivers packaged for
pip installwithout reposcripts/paths - ResMap locres comparison and related cohort exports
- Cluster
.sbatchgitignored — use READMEsbatch --wrapon ARC
See v0.3.1 release notes for the full feature list.
v0.3.1 — halfmap-qc CLI
Install
pip install cryoem-halfmap-qc
# or from git:
pip install "git+https://github.com/sarthaktexas/cryoem-halfmap-qc.git@v0.3.1"Highlights
halfmap-qcCLI —features,analyze,reliability,cohort,cohort-ids,help- Interactive TUI — run
halfmap-qcin a terminal for a guided menu - Packaged drivers — cohort and reliability pipelines work after
pip install(noscripts/path required) - PyPI publish workflow — this release triggers automated upload if trusted publishing is configured
- ResMap support — locres method comparison and alignment scripts
- Cluster scripts —
*.sbatchgitignored; use READMEsbatch --wrapone-liner on ARC
Quick start
halfmap-qc cohort --pending # batch from cohort/manifest.csv
halfmap-qc cohort --emd-id 49450 # single map
halfmap-qc help # full command referenceFull changelog (since v0.2.3)
- Add halfmap-qc CLI, interactive TUI, and PyPI packaging
- ResMap local-resolution comparison and cohort metric exports
- Placement utility and locres LOO extensions
- Trim README; gitignore cluster
.sbatchfiles - Thesis figure scripts remain local-only (gitignored)
v0.2.3
Summary
- Add Figma export tooling for thesis figures (Q vs V, cross-metric, placement, conformation pairs, reliability by class)
- Add shared
style/thesis_palette.pyand cohort summary CSV tables - Extend conformation-pair analysis (Cα RMSD), placement utility, and half-map reliability export
- Align Zenodo citation to concept DOI 10.5281/zenodo.20618526
Install
pip install "git+https://github.com/sarthaktexas/cryoem-halfmap-qc.git@v0.2.3"Tests
python -m unittest discover -s tests -vAll 82 tests pass on this release.
v0.2.2 — halfmap reliability, Q-score ablations, thesis figures
Summary
- Rename LH reliability export to
halfmap_reliabilitywith density-source support - Add Q-score constraint V gradient and window ablation runners
- Add metric schematic figure and Figma graphical-abstract export tooling
- Adopt thesis color palette for build zones and domain region annotations
- Add resumable FSC-Q cohort batch runner (
run_fscq_cohort_batch.py) - CI: switch to
unittest discover; skip ChimeraX map-shell test when reference maps are absent - Archive TV decoupling diagnostics runner under
scripts/archive/
Install
pip install "git+https://github.com/sarthaktexas/cryoem-halfmap-qc.git@v0.2.2"