{"name":"surforama","display_name":"Surforama","visibility":"hidden","icon":"","categories":["Annotation","Visualization"],"schema_version":"0.2.0","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"surforama.make_widget","title":"Make Surforama","python_name":"surforama:QtSurforama","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"surforama.thylakoid","title":"Thylakoid membrane","python_name":"surforama.data._datasets:_thylakoid_membrane_sample_data_plugin","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"surforama.covid","title":"Covid virion membrane","python_name":"surforama.data._datasets:_covid_membrane_sample_data_plugin","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"surforama.mesh_reader","title":"Mesh reader","python_name":"surforama.io._reader_plugin:mesh_reader_plugin","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"surforama.star_reader","title":"star reader","python_name":"surforama.io._reader_plugin:star_reader_plugin","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":[{"command":"surforama.mesh_reader","filename_patterns":["*.obj"],"accepts_directories":false},{"command":"surforama.star_reader","filename_patterns":["*.star"],"accepts_directories":false}],"writers":null,"widgets":[{"command":"surforama.make_widget","display_name":"Surforama","autogenerate":false}],"sample_data":[{"command":"surforama.thylakoid","key":"thylakoid","display_name":"thylakoid membrane"},{"command":"surforama.covid","key":"covid","display_name":"covid virion membrane"}],"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.1","name":"surforama","version":"0.0.9","dynamic":null,"platform":null,"supported_platform":null,"summary":"a tool for using surfaces to explore volumetric data in napari","description":"# surforama\na napari-based tool for using surfaces to explore volumetric data in napari\n\ninspired by [membranorama](https://github.com/dtegunov/membranorama)\n\n![Screenshot of surforama showing a surface in the slice of a tomogram](surforama_screenshot.png)\n\n## installation\n`surforama` requires the napari viewer. If you would like to install napari and surforama together in one line, you can use the following command:\n\n```bash\npip install \"surforama[napari]\"\n```\n\n\nIf you already have napari installed, you can directly install surforama in the same environment:\n\n```bash\npip install surforama\n```\n\n## usage\n### launch with demo data\nIf you'd like to test surforama out, you can launch surforama with demo data:\n\n```bash\nsurforama --demo\n```\n\n### launch without data\nYou can launch surforama using the command line interface. After you have installed surforama, you can launch it with the following command in your terminal:\n\n```bash\nsurforama\n```\nAfter surforama launches, you can load your image and mesh into napari and get surfing!\n\n### launch with data\nIf you have an MRC-formatted tomogram and an obj-formatted mesh, you can launch using the following command:\n\n```bash\nsurforama --image-path /path/to/image.mrc --mesh-path /path/to/mesh.obj\n```\n\n## developer installation\n\nIf you would like to make changes to the surforama source code, you can install surformama with the developer tools as follows:\n\n```bash\ncd /path/to/your/surforama/source/code/folder\npip install -e \".[dev]\"\n```\nWe use pre-commit to keep the code tidy. Install the pre-commit hooks to activate the checks:\n\n```bash\npre-commit install\n```\n","description_content_type":"text/markdown","keywords":null,"home_page":"https://github.com/cellcanvas/surforama","download_url":null,"author":"Kyle Harrington","author_email":"surforama@kyleharrington.com","maintainer":null,"maintainer_email":null,"license":"MIT","classifier":["Development Status :: 2 - Pre-Alpha","Framework :: napari","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: 3.10","Topic :: Scientific/Engineering :: Image Processing"],"requires_dist":["magicgui","mrcfile","numpy","pooch","qtpy","pyacvd","pyvista","rich","scikit-image","starfile","trimesh","typer","napari ; extra == 'dev'","pyqt5 ; extra == 'dev'","pytest ; extra == 'dev'","pytest-cov ; extra == 'dev'","pytest-qt ; extra == 'dev'","tox ; extra == 'dev'","pre-commit ; extra == 'dev'","napari[all] ; extra == 'napari'","napari ; extra == 'testing'","pyqt5 ; extra == 'testing'","pytest ; extra == 'testing'","pytest-cov ; extra == 'testing'","pytest-qt ; extra == 'testing'","tox ; extra == 'testing'"],"requires_python":">=3.8","requires_external":null,"project_url":["Bug Tracker, https://github.com/cellcanvas/surforama/issues","Documentation, https://github.com/cellcanvas/surforama#README.md","Source Code, https://github.com/cellcanvas/surforama","User Support, https://github.com/cellcanvas/surforama/issues"],"provides_extra":["dev","napari","testing"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}