{"id":27907,"library":"large-image-source-nd2","title":"large-image-source-nd2","description":"A tilesource for the large-image framework that reads ND2 (NIS Elements) files. Version 1.34.1, released May 2026, follows large-image releases about every 2-4 weeks.","status":"active","version":"1.34.1","language":"python","source_language":"en","source_url":"https://github.com/girder/large_image","tags":["nd2","tilesource","large-image","microscopy","nis-elements"],"install":[{"cmd":"pip install large-image-source-nd2","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core framework for the tilesource","package":"large-image","optional":false},{"reason":"Python library for reading ND2 files","package":"nd2","optional":false}],"imports":[{"note":"Correct import path from v1.0+","symbol":"ND2FileTileSource","correct":"from large_image_source_nd2 import ND2FileTileSource"},{"note":"Use open() function to open ND2 files","symbol":"open","correct":"from large_image_source_nd2 import open"}],"quickstart":{"code":"from large_image_source_nd2 import open\nts = open('path/to/file.nd2')\nprint(ts.getMetadata())\ntile = ts.getTile(0, 0, 0)\nprint(tile.shape)","lang":"python","description":"Open an ND2 file and get a tile at level 0, position (0,0)."},"warnings":[{"fix":"Always call ts.getMetadata() to get axes and sizes.","message":"ND2 files can contain multiple channels and frames; use getMetadata() to inspect dimensions before accessing tiles.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade to Python 3.10+.","message":"Requires Python >=3.10. Python 3.9 or earlier will fail to install.","severity":"breaking","affected_versions":">=1.34.0"},{"fix":"Upgrade Girder to 5+ or use large_image without Girder.","message":"Support for Girder <5 is deprecated; future versions may drop compatibility.","severity":"deprecated","affected_versions":">=1.34.1"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"pip install nd2","cause":"Missing dependency: nd2 library is not installed.","error":"ModuleNotFoundError: No module named 'nd2'"},{"fix":"Verify the file path and ensure the file exists.","cause":"File path is incorrect or file does not exist.","error":"FileNotFoundError: [Errno 2] No such file or directory: 'path/to/file.nd2'"},{"fix":"Use nd2 library directly to validate the file: from nd2 import ND2File; f = ND2File('file.nd2').","cause":"The file is not a valid ND2 format or is corrupted.","error":"ValueError: Invalid ND2 file"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}