Skip to main content

Half-map QC and local reliability scores for cryo-EM density maps

Project description

cryoem-halfmap-qc

PyPI version DOI License: MIT

Local reliability scores and build zones for cryo-EM maps from half-maps and density features. Python 3.10+.

pip install cryoem-halfmap-qc
halfmap-qc          # interactive: two half-map paths → two MRC outputs
halfmap-qc help     # CLI reference

Interactive mode asks for half-map 1 and half-map 2, offers auto or manual contour, warns when estimated resolution is outside the model-building band (>4 Å), then writes {stem}_reliability.mrc and {stem}_build_zones.mrc under halfmap_qc_out/ next to half-map 1.

halfmap-qc interactive menu

Pipeline (non-interactive / advanced)

Three commands, in order. Pass your own map paths and output directories.

# 1. Features from a map (.mrc / .map)
halfmap-qc features map.mrc --out features.npz --float32

# 2. Half-map metrics + correlations
halfmap-qc analyze \
  --features features.npz \
  --half1 half1.map --half2 half2.map \
  --reference ref.map \
  --contour CONTOUR \
  --out-dir analysis_out

# 3. Reliability score + build-zone MRCs
halfmap-qc reliability \
  --reference ref.map --half1 half1.map --half2 half2.map \
  --features features.npz \
  --contour CONTOUR \
  --out-dir reliability_out

--contour is the density threshold for the analysis mask (same value in steps 2 and 3). Step 2 (analyze) is optional if you only need the reliability and build-zone MRCs.

Reliability outputs: {label}_reliability.mrc and {label}_build_zones.mrc on your reference grid.

Flag details: halfmap-qc features --help, halfmap-qc analyze --help, halfmap-qc reliability --help.

HPC (ARC)

Default login python3 is too old (3.6). Conda modules load on compute nodes only:

srun -p compute1 -n 1 -t 02:00:00 --pty bash
module load miniconda/24.4.0
conda activate halfmap-qc    # after one-time: conda create -n halfmap-qc python=3.12 -y && pip install cryoem-halfmap-qc

Batch job — copy scripts/halfmap_qc_cluster.sbatch.example, set MAP, HALF1, HALF2, REF, CONTOUR, and submit. Each step aborts if the previous one fails.

cp scripts/halfmap_qc_cluster.sbatch.example run_my_map.sbatch
# edit paths in run_my_map.sbatch
sbatch run_my_map.sbatch

If install fails with empty (from versions:), check python --version (need ≥3.10) and pip install -U pip.

Citation

@software{mohanty2026cryoem_halfmap_qc,
  author = {Mohanty, Sarthak},
  title = {cryoem-halfmap-qc: local map reliability from cryo-EM density and half-maps},
  year = {2026},
  doi = {10.5281/zenodo.20618526},
  url = {https://doi.org/10.5281/zenodo.20618526},
  version = {0.6.0}
}

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cryoem_halfmap_qc-0.6.0.tar.gz (172.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cryoem_halfmap_qc-0.6.0-py3-none-any.whl (175.1 kB view details)

Uploaded Python 3

File details

Details for the file cryoem_halfmap_qc-0.6.0.tar.gz.

File metadata

  • Download URL: cryoem_halfmap_qc-0.6.0.tar.gz
  • Upload date:
  • Size: 172.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cryoem_halfmap_qc-0.6.0.tar.gz
Algorithm Hash digest
SHA256 cd45ce38d7130a41435f7c3f27ec554ffbc1190ede6cd91fd8fac125dece4397
MD5 df45287f039c839ce153524d4ad82c58
BLAKE2b-256 c9448e1ee8cf58d81874ef426efe3bc9f216e9a51557dace8ef9bbfa91e7465c

See more details on using hashes here.

Provenance

The following attestation bundles were made for cryoem_halfmap_qc-0.6.0.tar.gz:

Publisher: publish.yml on sarthaktexas/cryoem-halfmap-qc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cryoem_halfmap_qc-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cryoem_halfmap_qc-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8454b0ac7c3706886403a64ad67fb6694459531cef4696e1104f2c2d2a66d1c2
MD5 7bd3c3bd277974f8dec1df07d67b2272
BLAKE2b-256 d16a2e79f9ea2445044f974a5958cf178bb8fd640e7d6073faf5f2bb66893ef5

See more details on using hashes here.

Provenance

The following attestation bundles were made for cryoem_halfmap_qc-0.6.0-py3-none-any.whl:

Publisher: publish.yml on sarthaktexas/cryoem-halfmap-qc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page