widgyts
===============================
[](https://widgyts.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/yt-project/widgyts)
[](https://joss.theoj.org/papers/f86e07ce58fe8bb24d928943663d2751)
[](https://zenodo.org/badge/latestdoi/124116100)
A fully client-side pan-and-zoom widget, using WebAssembly, for variable mesh
datasets from yt. It runs in the browser, so once the data hits your notebook,
it's super fast and responsive!
If you'd like to dig into the Rust and WebAssembly portion of the code, you can
find it at https://github.com/data-exp-lab/rust-yt-tools/ and in the npm
package `@data-exp-lab/yt-tools`.
Check out our [SciPy 2018 talk](https://www.youtube.com/watch?v=5dl_m_6T2bU)
and the [associated slides](https://munkm.github.io/2018-07-13-scipy/) for more info!
Documentation
-------------
Our documentation is hosted at readthedocs. Take a look
[here](https://widgyts.readthedocs.io/en/latest/).
Installation
------------
To install using pip from the most recent released version:
$ pip install widgyts
To install using pip from this directory:
$ git clone https://github.com/yt-project/widgyts.git
$ cd widgyts
$ pip install .
For a development installation (requires npm),
$ git clone https://github.com/yt-project/widgyts.git
$ cd widgyts
$ pip install -e .
$ jupyter serverextension enable --py --sys-prefix widgyts
$ jupyter nbextension install --py --symlink --sys-prefix widgyts
$ jupyter nbextension enable --py --sys-prefix widgyts
Note that in previous versions, serverextension was not provided and you were
required to set up your own mimetype in your local configuration. This is no
longer the case and you are now able to use this server extension to set up the
correct wasm mimetype.
To install the jupyterlab extension, you will need to make sure you are on a
recent enough version of Jupyterlab, preferably 0.35 or above. For a
development installation, do:
$ jupyter labextension install js
To install the latest released version,
$ jupyter labextension install @yt-project/yt-widgets
Using
-----
To use this, you will need to have yt installed. Importing it monkeypatches
the Slice and Projection objects, so you are now able to do:
```
#!python
import yt
import widgyts
ds = yt.load("data/IsolatedGalaxy/galaxy0030/galaxy0030")
s = ds.r[:,:,0.5]
s.display("density")
```
and for a projection:
```
#!python
ds = yt.load("data/IsolatedGalaxy/galaxy0030/galaxy0030")
p = ds.r[:].integrate("density", axis="x")
p.display()
```
There are a number of traits you can set on the resultant objects, as well.
Raw data
{
"_id": null,
"home_page": "https://github.com/yt-project/widgyts",
"name": "widgyts",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "The yt Project",
"author_email": "yt-dev@python.org",
"download_url": "https://files.pythonhosted.org/packages/f8/a3/030188a45f107299a54e7e349702bf90019ebb790f0b3f66b5ba8ae16ef1/widgyts-0.5.1.tar.gz",
"platform": "Linux",
"description": "widgyts\n===============================\n\n[](https://widgyts.readthedocs.io/en/latest/?badge=latest)\n[](https://codecov.io/gh/yt-project/widgyts)\n[](https://joss.theoj.org/papers/f86e07ce58fe8bb24d928943663d2751)\n[](https://zenodo.org/badge/latestdoi/124116100)\n\n\nA fully client-side pan-and-zoom widget, using WebAssembly, for variable mesh\ndatasets from yt. It runs in the browser, so once the data hits your notebook,\nit's super fast and responsive!\n\nIf you'd like to dig into the Rust and WebAssembly portion of the code, you can\nfind it at https://github.com/data-exp-lab/rust-yt-tools/ and in the npm\npackage `@data-exp-lab/yt-tools`.\n\nCheck out our [SciPy 2018 talk](https://www.youtube.com/watch?v=5dl_m_6T2bU)\nand the [associated slides](https://munkm.github.io/2018-07-13-scipy/) for more info!\n\nDocumentation\n-------------\n\nOur documentation is hosted at readthedocs. Take a look\n[here](https://widgyts.readthedocs.io/en/latest/).\n\nInstallation\n------------\n\nTo install using pip from the most recent released version:\n\n $ pip install widgyts\n\nTo install using pip from this directory:\n\n $ git clone https://github.com/yt-project/widgyts.git\n $ cd widgyts\n $ pip install .\n\nFor a development installation (requires npm),\n\n $ git clone https://github.com/yt-project/widgyts.git\n $ cd widgyts\n $ pip install -e .\n $ jupyter serverextension enable --py --sys-prefix widgyts\n $ jupyter nbextension install --py --symlink --sys-prefix widgyts\n $ jupyter nbextension enable --py --sys-prefix widgyts\n\nNote that in previous versions, serverextension was not provided and you were\nrequired to set up your own mimetype in your local configuration. This is no\nlonger the case and you are now able to use this server extension to set up the\ncorrect wasm mimetype.\n\nTo install the jupyterlab extension, you will need to make sure you are on a\nrecent enough version of Jupyterlab, preferably 0.35 or above. For a\ndevelopment installation, do:\n\n $ jupyter labextension install js\n\nTo install the latest released version,\n\n $ jupyter labextension install @yt-project/yt-widgets\n\nUsing\n-----\n\nTo use this, you will need to have yt installed. Importing it monkeypatches\nthe Slice and Projection objects, so you are now able to do:\n\n```\n#!python\nimport yt\nimport widgyts\n\nds = yt.load(\"data/IsolatedGalaxy/galaxy0030/galaxy0030\")\ns = ds.r[:,:,0.5]\ns.display(\"density\")\n```\n\nand for a projection:\n\n```\n#!python\nds = yt.load(\"data/IsolatedGalaxy/galaxy0030/galaxy0030\")\np = ds.r[:].integrate(\"density\", axis=\"x\")\np.display()\n```\n\nThere are a number of traits you can set on the resultant objects, as well.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A Custom Jupyter Widget Library for Interactive Visualization with yt",
"version": "0.5.1",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8a3030188a45f107299a54e7e349702bf90019ebb790f0b3f66b5ba8ae16ef1",
"md5": "c9b28cbce9975bb990f9c8d4f5dc66a8",
"sha256": "cd46eba40c86bae9c73786e5f468be053042fa9f339d46b7a7d623f643bf3643"
},
"downloads": -1,
"filename": "widgyts-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "c9b28cbce9975bb990f9c8d4f5dc66a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 267579,
"upload_time": "2023-04-14T15:26:21",
"upload_time_iso_8601": "2023-04-14T15:26:21.298483Z",
"url": "https://files.pythonhosted.org/packages/f8/a3/030188a45f107299a54e7e349702bf90019ebb790f0b3f66b5ba8ae16ef1/widgyts-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-14 15:26:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "yt-project",
"github_project": "widgyts",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "widgyts"
}
JSON
