Source code for tooluniverse.tools.get_assembly_summary

"""
get_assembly_summary

Get key assembly composition and symmetry summary for an assembly associated with a PDB entry.
"""

from typing import Any, Optional, Callable
from ._shared_client import get_shared_client


[docs] def get_assembly_summary( assembly_id: str, *, stream_callback: Optional[Callable[[str], None]] = None, use_cache: bool = False, validate: bool = True, ) -> Any: """ Get key assembly composition and symmetry summary for an assembly associated with a PDB entry. Parameters ---------- assembly_id : str Assembly ID in format 'PDBID-assemblyNumber' (e.g., '1A8M-1') stream_callback : Callable, optional Callback for streaming output use_cache : bool, default False Enable caching validate : bool, default True Validate parameters Returns ------- Any """ # Handle mutable defaults to avoid B006 linting error return get_shared_client().run_one_function( {"name": "get_assembly_summary", "arguments": {"assembly_id": assembly_id}}, stream_callback=stream_callback, use_cache=use_cache, validate=validate, )
__all__ = ["get_assembly_summary"]