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

You can install the EMDB client via pip:

pip install emdb

✨ 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.6.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.6-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: emdb-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 676e10d4e75988f5d4e8afb268bb11f0067d601b7079defddda8f48367365661
MD5 27a7661aedfc0ba96e8b989da0df6972
BLAKE2b-256 f7c575c2dc8fa9a20869f01d49cd45a23ef202d4b17918f9c99b30ac57cea7d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: emdb-0.1.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 edb3d9686a4d39319040dd253712714d3ad96d70eb9435d89c92ef2b4e4e8296
MD5 aca802aaed320a4b84d688fdf565d1c7
BLAKE2b-256 07a8ecf84adb4b48e1e722eba38db444c63356cd12b3c45fb06ca6f8648c7422

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