{"id":18191927,"url":"https://github.com/insightsoftwareconsortium/itkwidgets","last_synced_at":"2025-05-14T12:08:00.845Z","repository":{"id":29400178,"uuid":"121581663","full_name":"InsightSoftwareConsortium/itkwidgets","owner":"InsightSoftwareConsortium","description":"An elegant Python interface for visualization on the web platform to interactively generate insights into multidimensional images, point sets, and geometry.","archived":false,"fork":false,"pushed_at":"2025-03-13T21:30:06.000Z","size":80603,"stargazers_count":596,"open_issues_count":124,"forks_count":83,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-04-15T03:53:34.955Z","etag":null,"topics":["image-analysis","imaging","insight-toolkit","itk","jupyter","jupyter-widget","jupyterlab-extension","kitware","medical-visualization","meshes","open-science","open-source","point-cloud","python","reproducible-research","scientific-computing","scientific-visualization"],"latest_commit_sha":null,"homepage":"https://itkwidgets.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/InsightSoftwareConsortium.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-15T01:43:39.000Z","updated_at":"2025-03-29T09:10:27.000Z","dependencies_parsed_at":"2023-02-14T21:15:31.471Z","dependency_job_id":"692ef975-003f-4ae5-8ad7-a0cd766507b4","html_url":"https://github.com/InsightSoftwareConsortium/itkwidgets","commit_stats":{"total_commits":460,"total_committers":8,"mean_commits":57.5,"dds":0.4782608695652174,"last_synced_commit":"edff2bcec8259bf48e44327213cc70b67744da13"},"previous_names":["insightsoftwareconsortium/itk-jupyter-widgets"],"tags_count":119,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2Fitkwidgets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2Fitkwidgets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2Fitkwidgets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2Fitkwidgets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InsightSoftwareConsortium","download_url":"https://codeload.github.com/InsightSoftwareConsortium/itkwidgets/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249003955,"owners_count":21196794,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["image-analysis","imaging","insight-toolkit","itk","jupyter","jupyter-widget","jupyterlab-extension","kitware","medical-visualization","meshes","open-science","open-source","point-cloud","python","reproducible-research","scientific-computing","scientific-visualization"],"created_at":"2024-11-03T06:03:16.899Z","updated_at":"2025-04-15T03:53:42.624Z","avatar_url":"https://github.com/InsightSoftwareConsortium.png","language":"Python","readme":"# itkwidgets\n\n[![Documentation Status](https://readthedocs.org/projects/itkwidgets/badge/?version=latest)](https://itkwidgets.readthedocs.io/en/latest/?badge=latest)\n[![Notebook tests](https://github.com/InsightSoftwareConsortium/itkwidgets/actions/workflows/notebook-test.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itkwidgets/actions/workflows/notebook-test.yml)\n[![DOI](https://zenodo.org/badge/121581663.svg)](https://zenodo.org/doi/10.5281/zenodo.3603358)\n\n\nITKWidgets is an elegant Python interface for visualization on the web platform to interactively generate insights into multidimensional images, point sets, and geometry.\n\n![Hello 3D World](./docs/images/Hello3DWorld.gif)\n\n# Getting Started\n\n## Environment Setup\n\nThe [EnvironmentCheck.ipynb](https://github.com/InsightSoftwareConsortium/itkwidgets/blob/main/examples/EnvironmentCheck.ipynb) checks the environment that you are running in to make sure that all required dependencies and extensions are correctly installed. Ideally run first before any other notebooks to prevent common issues around dependencies and extension loading.\n\n## Installation\n\nTo install for all environments:\n\n```bash\npip install 'itkwidgets[all]\u003e=1.0a55'\n```\n\n### Jupyter Notebook\n\nTo install the widgets for the Jupyter Notebook with pip:\n\n```bash\npip install 'itkwidgets[notebook]\u003e=1.0a55'\n```\n\nThen look for the ImJoy icon at the top in the Jupyter Notebook:\n\n![ImJoy Icon in Jupyter Notebook](docs/images/imjoy-notebook.png)\n\n### Jupyter Lab\n\nFor Jupyter Lab 3 run:\n\n```bash\npip install 'itkwidgets[lab]\u003e=1.0a55'\n```\n\nThen look for the ImJoy icon at the top in the Jupyter Notebook:\n\n![ImJoy Icon in Jupyter Lab](docs/images/imjoy-lab.png)\n\n### Google Colab\n\nFor Google Colab run:\n\n```bash\npip install 'itkwidgets\u003e=1.0a55'\n```\n\n## Example Notebooks\n\nExample Notebooks can be accessed locally by cloning the repository:\n\n```bash\ngit clone -b main https://github.com/InsightSoftwareConsortium/itkwidgets.git\n```\n\nThen navigate into the examples directory:\n\n```bash\ncd itkwidgets/examples\n```\n\n## Usage\n\nIn Jupyter, import the view function:\n\n```python\nfrom itkwidgets import view\n```\n\nThen, call the view function at the end of a cell, passing in the image to examine:\n\n```python\nview(image)\n```\n\nFor information on additional options, see the view function docstring:\n\n```python\nview?\n```\n\nSee the [deployments](docs/deployments.md) section for a more detailed overview of additional notebook\noptions as well as other ways to run and interact with your notebooks.\n\n# Learn more\n\nVisit the [docs](https://itkwidgets.readthedocs.io/en/latest/) for more information on supported notebooks and integrations.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsoftwareconsortium%2Fitkwidgets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsightsoftwareconsortium%2Fitkwidgets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsoftwareconsortium%2Fitkwidgets/lists"}