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 menu
halfmap-qc help     # CLI reference

halfmap-qc interactive menu

Pipeline

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 \
  --halfmap-npz analysis_out/halfmap_metrics.npz \
  --contour CONTOUR \
  --out-dir reliability_out

--contour is the density threshold for the analysis mask (same value in steps 2 and 3). Optional: --local-res path.mrc on reliability for a local-resolution comparison figure.

Outputs: reliability_score and omit / caution / build zones as MRC overlays on your reference grid, plus .npz and summary JSON under --out-dir.

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.5.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.5.1.tar.gz (155.3 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.5.1-py3-none-any.whl (161.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cryoem_halfmap_qc-0.5.1.tar.gz
  • Upload date:
  • Size: 155.3 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.5.1.tar.gz
Algorithm Hash digest
SHA256 1cce5f82846cf8591504d1d226ef79cb73a8e84cd094b453f6a5610c3687b450
MD5 7d3537f9e398b9e5f268044aebe050bb
BLAKE2b-256 bba21b68019fb88c666fd91cb13a5cf4eb1c87fc9cd44fbf4e6f5aa697fde4b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for cryoem_halfmap_qc-0.5.1.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.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cryoem_halfmap_qc-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d26366013a50a20b4804ea3ea882b630dd235e5a8a5611a0d4fce8a3168881b5
MD5 e23d06929ceab9e764b4ee8bdfed18b4
BLAKE2b-256 22e7afe797157aca623f09d5bb8762693af55d0393f6173d857d5ae34b4dcdd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for cryoem_halfmap_qc-0.5.1-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