Skip to main content

cryoRIDGE — Reliability Inferred from Density Gradient Energy for cryo-EM maps

Project description

cryoRIDGE

RIDGE = Reliability Inferred from Density Gradient Energy

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 cryoridge
cryoridge          # interactive: two half-map paths → two MRC outputs
cryoridge 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 cryoridge_out/ next to half-map 1.

Pipeline (non-interactive / advanced)

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

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

# 2. Half-map metrics + correlations
cryoridge 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
cryoridge 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: cryoridge features --help, cryoridge analyze --help, cryoridge 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 cryoridge    # after one-time: conda create -n cryoridge python=3.12 -y && pip install cryoridge

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

cp scripts/cryoridge_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{mohanty2026cryoridge,
  author = {Mohanty, Sarthak},
  title = {cryoRIDGE: Reliability Inferred from Density Gradient Energy},
  year = {2026},
  doi = {10.5281/zenodo.20618526},
  url = {https://doi.org/10.5281/zenodo.20618526},
  version = {0.8.1}
}

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

cryoridge-0.8.1.tar.gz (122.7 kB view details)

Uploaded Source

Built Distribution

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

cryoridge-0.8.1-py3-none-any.whl (117.1 kB view details)

Uploaded Python 3

File details

Details for the file cryoridge-0.8.1.tar.gz.

File metadata

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

File hashes

Hashes for cryoridge-0.8.1.tar.gz
Algorithm Hash digest
SHA256 1afa1e4644cc511a6bb23474f3631f4c0566d5f88dd2275dd3cdbc920f814b0c
MD5 36989e84b2696b8413371b1e818c947c
BLAKE2b-256 a330a2fbbdc12890ae9a75bca5a87b51353f4b6b14909128ad270531616f6986

See more details on using hashes here.

Provenance

The following attestation bundles were made for cryoridge-0.8.1.tar.gz:

Publisher: publish.yml on sarthaktexas/cryoRIDGE

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

File details

Details for the file cryoridge-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: cryoridge-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 117.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cryoridge-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d7dd5b570686c1663cacfd2ef5055647810553aa7ec03cd1adfa789408d1107
MD5 7513da616579b4fb9e25d396cfbc3586
BLAKE2b-256 d0dcf680efd8148b0cc5853fe427d0a57891f72aec38128e196039231c827bd0

See more details on using hashes here.

Provenance

The following attestation bundles were made for cryoridge-0.8.1-py3-none-any.whl:

Publisher: publish.yml on sarthaktexas/cryoRIDGE

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