Skip to main content

A Python client for accessing the Electron Microscopy Data Bank (EMDB)

Project description

EMDB Python Client

A Python client for accessing and interacting with the Electron Microscopy Data Bank (EMDB).
This package provides an easy-to-use interface to query EMDB entries, access metadata, and download associated files.

🚀 Features

  • Retrieve EMDB entries by ID
  • Query metadata such as resolution, sample description, and related PDBs
  • Download associated files (maps, images, metadata)
  • Utility models for plotting and file handling
  • Access to validation analysis and annotation data

📚 Documentation

Full API documentation is available at:
👉 https://emdb.readthedocs.io/en/latest/

🔧 Installation

COMING SOON

✨ Quick Start

from emdb.client import EMDB
from emdb.exceptions import EMDBNotFoundError

client = EMDB()

try:
    # Retrieve an entry by ID
    entry = client.get_entry("EMD-8117")
    print(entry.resolution)
    
    # Access cross-reference annotations
    annotations = entry.get_annotations()
    print(annotations)
    
    # Access validation data and plot FSC
    validation = entry.get_validation()
    validation.plots.fsc.plot()
    
    # Download all files
    entry.download_all_files(output_dir="/tmp/emd1234/")
except EMDBNotFoundError:
    print("Entry not found.")

🧪 Tests

COMING SOON

🛠 Requirements

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

📄 License

This project is licensed under the Apache License 2.0.

📧 Contact

For questions or feedback, please open an issue on GitHub or contact the maintainers.

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

emdb-0.1.5.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

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

emdb-0.1.5-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file emdb-0.1.5.tar.gz.

File metadata

  • Download URL: emdb-0.1.5.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for emdb-0.1.5.tar.gz
Algorithm Hash digest
SHA256 aa07b65c52eb535a146e9825b4905431a89e8c877356f8f9b8f04b2811bab128
MD5 53bb0028c672527e6528c4753098627d
BLAKE2b-256 94a4b8e015b3f5c3f83a7a5ba484050b1fb2841f1e43254f112ca27fda43c0d6

See more details on using hashes here.

File details

Details for the file emdb-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: emdb-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for emdb-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a0979d1668cc58d2ccc78be9c77c9fe98f422bc6b9a7645b7cf8dd07b28ab6bd
MD5 ce1cb8d2e8108ba88077a0cb78b82220
BLAKE2b-256 b12b3c07c719ebd4b43af59d44cb22175b43babfb48368277886a18ff57177ac

See more details on using hashes here.

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