{ "info": { "author": "Jan Freyberg", "author_email": "jan.freyberg@gmail.com", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# Neuroimaging Widgets (`niwidgets`)\n\nThis repository is supposed to provide easy and general wrappers to display\ninteractive widgets that visualise standard-format neuroimaging data, using new\nfunctions and standard functions from other libraries. It looks like this:\n\n![](https://thumbs.gfycat.com/ExcitableReflectingLcont-size_restricted.gif)\n\nInstall via:\n\n```\npip install niwidgets\n```\n\nOr, to get the most up-to-date development version from github:\n\n```\npip install git+git://github.com/nipy/niwidgets/\n```\n\nIt requires nibabel and nilearn:\n\n```\npip install nibabel nilearn\n```\n\nCheck out the examples using the code in this notebook here:\nhttps://github.com/nipy/niwidgets/blob/master/index.ipynb (you need to run the\nnotebook on your local machine to use the interactive features).\n\nor using binder here:\nhttps://mybinder.org/v2/gh/nipy/niwidgets/master?filepath=index.ipynb\n\n### Usage:\n\nThere are currently three supported widgets:\n\n1. Volume widgets. This widget is primarily designed to mimic existing tools\nsuch as , but it also allows you to wrap plots from the `nilearn`\nplotting library to make them interactive.\n\n2. Surface widgets. This widget takes freesurfer-generated volume files and\nturns them into widgets using the `ipyvolume` library. It allows you to add\ndifferent overlays for the surface files.\n\n3. Streamline widgets. This widget accepts `.trk` files and displays the tracts\nusing `ipyvolume`.\n\nTo see how to use these widgets, please check the\n[documentation](nipy.org/niwidgets).\n\nAs an example of how you might generate a Volume widget:\n\n```\nfrom niwidgets import NiftiWidget\n\nmy_widget = NiftiWidget('./path/to/file.nii')\n```\n\nYou can then create a plot either with the default nifti plotter:\n\n```\nmy_widget.nifti_plotter()\n```\n\nThis will give you sliders to slice through the image, and an option to set the\ncolormap.\n\nYou can also provide your own plotting function:\n\n```\nimport nilearn.plotting as nip\n\nmy_widget.nifti_plotter(plotting_func=nip.plot_glass_brain)\n```\n\nBy default, this will give you the following interactive features: -\nselecting a colormap - if supported by the plotting function, x-y-x\nsliders (e.g. for `nip.plot_img`)\n\n\nYou can, however, always provide features you would like to have interactive\nyourself. This follows the normal ipywidgets format. For example, if you provide\na list of strings for a keyword argument, this becomes a drop-down menu. If you\nprovide a tuple of two numbers, this becomes a slider. Take a look at some\nexamples we have in [this\nnotebook](https://github.com/janfreyberg/niwidgets/blob/master/visualisation_wrapper.ipynb)\n(you need to run the notebook on your local machine to use the interactive\nfeatures).\n\nHopefully we will be able to add more default interactive features in the\nfuture, as well as plotting of other data (such as surface projections). If you\nhave any suggestions for plot features to be added, please let us know - or add\nthem yourself and create a pull request!\n\n## Development\n\n![](https://travis-ci.org/nipy/niwidgets.svg?branch=master)\n\n### Contributing\n\nPlease contribute! When writing new widgets, please make sure you include\nexample data that allows users to try a widget without having to munge their\ndata into the right format first.\n\nPlease also make sure you write a test for your new widget. It's hard to test\njupyter widgets, but it would be great if you could at least write a test that\n\"instantiates\" a widget. This allows us to maintain a stable release.\n\n### Development installation\n\nAs always with pip packages, you can install a _\"development\"_ version of this\npackage by cloning the git repository and installing it via `pip install -e\n/path/to/package`.\n\n### Updating the documentation\n\nTo update the documentation, you can do the following things:\n\n- Make your changes on a separate branch, such as DOC/update-api-documentation.\n- Merge your branch into master Make sure you have the packages in\n- `doc-requirements.txt` installed Run `make gh-pages` in the root directory of\n- the repository\n\nThis should run sphinx to generate the documentation, push it to the gh-pages\nbranch, and then revert to master.\n\n---\n\n_Developed by [Jan Freyberg](http://www.twitter.com/janfreyberg), [Bjoern\nSoergel](http://www.ast.cam.ac.uk/~bs538/), [Satrajit\nGhosh](https://github.com/satra), [Melanie\nGanz](https://github.com/melanieganz), [Murat\nBilgel](https://github.com/bilgelm), [Ariel Rokem](https://github.com/arokem),\nand [elyb01](https://github.com/elyb01)._\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "", "license": "", "maintainer": "Jan Freyberg", "maintainer_email": "jan.freyberg@gmail.com", "name": "niwidgets", "package_url": "https://pypi.org/project/niwidgets/", "platform": "", "project_url": "https://pypi.org/project/niwidgets/", "project_urls": null, "release_url": "https://pypi.org/project/niwidgets/0.2.2/", "requires_dist": [ "ipywidgets (>=7.4,<8.0)", "nibabel (>=2.4,<3.0)", "ipyvolume (>=0.5.1,<0.6.0)", "matplotlib (>=3.0,<4.0)", "numpy (>=1.16,<2.0)", "scipy (>=1.2,<2.0)", "nilearn (>=0.5.2,<0.6.0)", "scikit-learn (>=0.20.3,<0.21.0)" ], "requires_python": ">=3.5,<4.0", "summary": "'Interactive jupyter widgets for neuroimaging.'", "version": "0.2.2" }, "last_serial": 5176074, "releases": { "0.1.3": [ { "comment_text": "", "digests": { "md5": "2e90710aee5a3efc63175b1dc8bf3d23", "sha256": "6a36bc86f419f0990ec6af124fbaf9dd0f2a9aa44952dd542498c01e4bd6502a" }, "downloads": -1, "filename": "niwidgets-0.1.3.tar.gz", "has_sig": false, "md5_digest": "2e90710aee5a3efc63175b1dc8bf3d23", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4732250, "upload_time": "2017-08-13T09:41:24", "url": "https://files.pythonhosted.org/packages/08/d6/24a0b41621c712c8c2346a73a00cd7a6d682fd96262acd849323b08689e2/niwidgets-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "b98c0b275f3cc40b4308de65bdd2a089", "sha256": "a302adec8fd80a14ff22d9ce9588077c9803caa00f54e0b05fb9ad3d843998a1" }, "downloads": -1, "filename": "niwidgets-0.1.4.tar.gz", "has_sig": false, "md5_digest": "b98c0b275f3cc40b4308de65bdd2a089", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4738289, "upload_time": "2017-11-26T18:06:56", "url": "https://files.pythonhosted.org/packages/f3/55/29ce4c41fa88f7844587f050d5496b1bad6ff730a6ef52e8dd7dbc9fcdb9/niwidgets-0.1.4.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "4107f345f5361d23a47679da8095f635", "sha256": "163a293aedd5ffc8bd1d0ec131bb903d633e9a167189614d7f6e28e38a71321d" }, "downloads": -1, "filename": "niwidgets-0.2.0.tar.gz", "has_sig": false, "md5_digest": "4107f345f5361d23a47679da8095f635", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8185858, "upload_time": "2018-04-22T20:32:21", "url": "https://files.pythonhosted.org/packages/79/58/2e03d135a9ce7e1593b7f397c0ed102b4cf6e8ec27877d5ceefa797a46b0/niwidgets-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "56f918473f787777ebe3d6da9d92cf5f", "sha256": "4459503345976cf0ebe4a5e3870718e08de0956fe0f2b15e9be42de626c69732" }, "downloads": -1, "filename": "niwidgets-0.2.1.tar.gz", "has_sig": false, "md5_digest": "56f918473f787777ebe3d6da9d92cf5f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8187456, "upload_time": "2018-06-07T12:51:19", "url": "https://files.pythonhosted.org/packages/bd/0b/d9001238ce9997ea970afc80d512a511b07413327034f565807acdaafc2e/niwidgets-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "5c53278f92f06e8f3f290a796d46f9d1", "sha256": "f7473ab8bb4ab0f5110ca2c336b0583af5e48b8e5b882e75e49e99b4dfd438c3" }, "downloads": -1, "filename": "niwidgets-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5c53278f92f06e8f3f290a796d46f9d1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5,<4.0", "size": 12474160, "upload_time": "2019-04-23T08:43:52", "url": "https://files.pythonhosted.org/packages/b8/d8/a3f7b9a295670bf7ea4ef1dd421867751b93582ebf8c57777aa9b3f83462/niwidgets-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27fd455fac12ecb3011d18147b368c48", "sha256": "42af7c72b18d68d97835c8c05b5b857fc0b3413cd427fdba9125b346c2d2736a" }, "downloads": -1, "filename": "niwidgets-0.2.2.tar.gz", "has_sig": false, "md5_digest": "27fd455fac12ecb3011d18147b368c48", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5,<4.0", "size": 12476738, "upload_time": "2019-04-23T08:43:56", "url": "https://files.pythonhosted.org/packages/a7/e6/3fe2f13c85bdccc7dbf1a259d03cd8b2604aadfc1b2093877107a4f54d34/niwidgets-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5c53278f92f06e8f3f290a796d46f9d1", "sha256": "f7473ab8bb4ab0f5110ca2c336b0583af5e48b8e5b882e75e49e99b4dfd438c3" }, "downloads": -1, "filename": "niwidgets-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5c53278f92f06e8f3f290a796d46f9d1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5,<4.0", "size": 12474160, "upload_time": "2019-04-23T08:43:52", "url": "https://files.pythonhosted.org/packages/b8/d8/a3f7b9a295670bf7ea4ef1dd421867751b93582ebf8c57777aa9b3f83462/niwidgets-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27fd455fac12ecb3011d18147b368c48", "sha256": "42af7c72b18d68d97835c8c05b5b857fc0b3413cd427fdba9125b346c2d2736a" }, "downloads": -1, "filename": "niwidgets-0.2.2.tar.gz", "has_sig": false, "md5_digest": "27fd455fac12ecb3011d18147b368c48", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5,<4.0", "size": 12476738, "upload_time": "2019-04-23T08:43:56", "url": "https://files.pythonhosted.org/packages/a7/e6/3fe2f13c85bdccc7dbf1a259d03cd8b2604aadfc1b2093877107a4f54d34/niwidgets-0.2.2.tar.gz" } ] }