{"id":27838,"library":"girder-large-image-annotation","title":"girder-large-image-annotation","description":"A Girder plugin to store and display annotations on large, multiresolution images. Current version 1.34.1, requires Python >=3.10. Part of the large_image ecosystem; releases occur every few months with minor improvements and bug fixes.","status":"active","version":"1.34.1","language":"python","source_language":"en","source_url":"https://github.com/girder/large_image","tags":["girder","annotation","large-image","histomics","plugin"],"install":[{"cmd":"pip install girder-large-image-annotation","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core Girder framework; plugin is designed to run inside Girder.","package":"girder","optional":false},{"reason":"Required for large image tile serving and annotation rendering.","package":"girder-large-image","optional":false},{"reason":"Older annotation plugin; may conflict if both are loaded.","package":"girder-annotation","optional":true}],"imports":[{"note":"The package name is girder-large-image-annotation, but the import is under the Girder plugin system, not a top-level Python module.","wrong":"from gadm import GirderAnnotationPlugin","symbol":"GirderAnnotationPlugin","correct":"from girder.plugins import GirderAnnotationPlugin"},{"note":"Access models through Girder's plugin module structure.","symbol":"AnnotationModel","correct":"from girder.plugins.large_image.models.annotation import AnnotationModel"}],"quickstart":{"code":"import os\nfrom girder.client import GirderClient\n\nclient = GirderClient(apiUrl=os.environ.get('GIRDER_API_URL', 'http://localhost:8080/api/v1'))\nclient.authenticate(apiKey=os.environ.get('GIRDER_API_KEY', ''))\n\n# Example: list annotations for an item\nitem_id = os.environ.get('ITEM_ID', '')\nif item_id:\n    annotations = client.get(f'annotation?itemId={item_id}')\n    print(annotations)","lang":"python","description":"Initialize Girder client and fetch annotations for a given item."},"warnings":[{"fix":"Upgrade to Python >=3.10 or use girder-large-image-annotation==1.33.5.","message":"girder-large-image-annotation v1.34.0 drops support for Python <3.10. Existing Python 3.8/3.9 deployments must upgrade Python or pin to an older version.","severity":"breaking","affected_versions":">=1.34.0"},{"fix":"Run 'pip uninstall girder-annotation' if it is installed.","message":"The old 'girder-annotation' plugin may conflict with this plugin. It is deprecated and should be uninstalled before installing girder-large-image-annotation.","severity":"deprecated","affected_versions":"all"},{"fix":"Use Girder's plugin loading mechanism (e.g., add to girder config or use girder-client to enable).","message":"The plugin must be loaded as a Girder plugin; it cannot be imported like a standard Python library. Running 'import girder_large_image_annotation' will fail.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Do not attempt to import directly. Enable the plugin in Girder configuration under 'plugins' list as 'large_image_annotation'.","cause":"The installed package uses hyphens in the name but the import path is different. The package is a Girder plugin, not a regular module.","error":"ModuleNotFoundError: No module named 'girder_large_image_annotation'"},{"fix":"Enable 'girder_large_image' plugin before 'large_image_annotation' in your Girder configuration.","cause":"Missing dependency plugin 'girder-large-image' is not enabled.","error":"girder.plugins.loading.PluginLoadError: Plugin 'large_image_annotation' requires 'girder_large_image' to be loaded."},{"fix":"Upgrade Girder to version 3.x or later.","cause":"Incompatible with very old Girder versions (pre-3.0). The plugin supports Girder >=3.","error":"pkg_resources.VersionConflict: (girder 2.x.x ...)"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}