jupyterview


Namejupyterview JSON
Version 0.5.2 PyPI version JSON
download
home_pagehttps://github.com/trungleduc/jupyterview
SummaryA Jupyterlab VTK viewer extension.
upload_time2022-06-23 20:21:47
maintainer
docs_urlNone
authorTrung Le
requires_python>=3.6
licenseBSD-3-Clause
keywords jupyter jupyterlab jupyterlab3
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">jupyterview</h1>

[![Github Actions Status](https://github.com/trungleduc/jupyterview/workflows/Build/badge.svg)](https://github.com/trungleduc/jupyterview/actions/workflows/build.yml) [![Lite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://trungleduc.github.io/jupyterview) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trungleduc/jupyterview/master?urlpath=lab) [![GitHub license](https://badgen.net/github/license/trungleduc/jupyterview)](https://github.com/trungleduc/jupyterview/blob/master/LICENSE) [![PyPI version](https://badge.fury.io/py/jupyterview.svg)](https://badge.fury.io/py/jupyterview) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/jupyterview.svg)](https://anaconda.org/conda-forge/jupyterview)

<h2 align="center"> VTK Data visualization extension for JupyterLab</h2>

**jupyterview** is an extension that adds the `VTK` data visualization capability to JupyterLab.

Powered by Kitware's `vtk.js` and `itk-wasm` library, **jupyterview** is a pure frontend extension, it does not require any kernel to operate and fully supports the Real-Time Collaboration feature of JupyterLab.

**jupyterview** is fully compatible with `jupyterlite`, it is available online at [jupyterview demo link](https://trungleduc.github.io/jupyterview).

## Features

- Visualize structured and unstructured data (`.vtu`, `.vtp`, `.vtk` flies).

![vtu](https://user-images.githubusercontent.com/4451292/157323037-f0d8149c-410b-483b-812a-3a4e3d524552.gif)

- Visualize and animate `.pvd` files.

![pvd](https://user-images.githubusercontent.com/4451292/157324587-0b89159d-f4db-4227-b58b-437c75f69855.gif)

- Visualize mesh supported by `meshio` library. Full list of supported formats is available at https://github.com/nschloe/meshio

https://user-images.githubusercontent.com/4451292/173418573-1839d689-763f-42ba-add3-4eaac4c87d7e.mp4

- Real-time collaborative visualization.

![colab](https://user-images.githubusercontent.com/4451292/157325576-c79c9ee8-6428-4e96-afa6-827467e70438.gif)

- Multiple display modes: `Surface`, `Surface with Edge`, `Wireframe` and `Points`
- Color scale and isocolor effet.
- Warp by scalar effet.

## Requirements

- JupyterLab >= 3.0

## Install

To install the extension, execute:

```bash
pip install jupyterview
```

or with mamba/conda

```bash
  conda install -c conda-forge  jupyterview
```

## Contributing

### Development install

Note: You will need NodeJS to build the extension package.

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Change directory to the jupyterview directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
```

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

```bash
jupyter lab build --minimize=False
```

### Development uninstall

```bash
pip uninstall jupyterview
```

In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyterview` within that folder.

### Packaging the extension

See [RELEASE](RELEASE.md)

## Thanks

The following libraries / open-source projects were used or inspired in the development of jupyterview:

- [vtk.js](https://github.com/Kitware/vtk-js)
- [itk-wasm](https://github.com/InsightSoftwareConsortium/itk-wasm)
- [paraview-glance](https://github.com/Kitware/paraview-glance)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/trungleduc/jupyterview",
    "name": "jupyterview",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "Jupyter,JupyterLab,JupyterLab3",
    "author": "Trung Le",
    "author_email": "leductrungxf@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/23/c1/68de43c26090eed7a9747f78cd37f313e4f468bc7bbdb30ffe70e0c98341/jupyterview-0.5.2.tar.gz",
    "platform": "Linux",
    "description": "<h1 align=\"center\">jupyterview</h1>\n\n[![Github Actions Status](https://github.com/trungleduc/jupyterview/workflows/Build/badge.svg)](https://github.com/trungleduc/jupyterview/actions/workflows/build.yml) [![Lite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://trungleduc.github.io/jupyterview) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trungleduc/jupyterview/master?urlpath=lab) [![GitHub license](https://badgen.net/github/license/trungleduc/jupyterview)](https://github.com/trungleduc/jupyterview/blob/master/LICENSE) [![PyPI version](https://badge.fury.io/py/jupyterview.svg)](https://badge.fury.io/py/jupyterview) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/jupyterview.svg)](https://anaconda.org/conda-forge/jupyterview)\n\n<h2 align=\"center\"> VTK Data visualization extension for JupyterLab</h2>\n\n**jupyterview** is an extension that adds the `VTK` data visualization capability to JupyterLab.\n\nPowered by Kitware's `vtk.js` and `itk-wasm` library, **jupyterview** is a pure frontend extension, it does not require any kernel to operate and fully supports the Real-Time Collaboration feature of JupyterLab.\n\n**jupyterview** is fully compatible with `jupyterlite`, it is available online at [jupyterview demo link](https://trungleduc.github.io/jupyterview).\n\n## Features\n\n- Visualize structured and unstructured data (`.vtu`, `.vtp`, `.vtk` flies).\n\n![vtu](https://user-images.githubusercontent.com/4451292/157323037-f0d8149c-410b-483b-812a-3a4e3d524552.gif)\n\n- Visualize and animate `.pvd` files.\n\n![pvd](https://user-images.githubusercontent.com/4451292/157324587-0b89159d-f4db-4227-b58b-437c75f69855.gif)\n\n- Visualize mesh supported by `meshio` library. Full list of supported formats is available at https://github.com/nschloe/meshio\n\nhttps://user-images.githubusercontent.com/4451292/173418573-1839d689-763f-42ba-add3-4eaac4c87d7e.mp4\n\n- Real-time collaborative visualization.\n\n![colab](https://user-images.githubusercontent.com/4451292/157325576-c79c9ee8-6428-4e96-afa6-827467e70438.gif)\n\n- Multiple display modes: `Surface`, `Surface with Edge`, `Wireframe` and `Points`\n- Color scale and isocolor effet.\n- Warp by scalar effet.\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterview\n```\n\nor with mamba/conda\n\n```bash\n  conda install -c conda-forge  jupyterview\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyterview directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\npip uninstall jupyterview\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupyterview` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n\n## Thanks\n\nThe following libraries / open-source projects were used or inspired in the development of jupyterview:\n\n- [vtk.js](https://github.com/Kitware/vtk-js)\n- [itk-wasm](https://github.com/InsightSoftwareConsortium/itk-wasm)\n- [paraview-glance](https://github.com/Kitware/paraview-glance)\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "A Jupyterlab VTK viewer extension.",
    "version": "0.5.2",
    "split_keywords": [
        "jupyter",
        "jupyterlab",
        "jupyterlab3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2cb9096f7b617dd9f66b8ba3a794d2f6",
                "sha256": "5c7a8d11987b082b073ecf277655107943c701f47566c5741d6ff22a31e01b39"
            },
            "downloads": -1,
            "filename": "jupyterview-0.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2cb9096f7b617dd9f66b8ba3a794d2f6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 26935958,
            "upload_time": "2022-06-23T20:21:43",
            "upload_time_iso_8601": "2022-06-23T20:21:43.361768Z",
            "url": "https://files.pythonhosted.org/packages/16/67/7012ad066395a1732956024a5a2648c3364392c88d4e4a088379829177d7/jupyterview-0.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "60c66476993bb399fadabf0e88b7fc34",
                "sha256": "3eb92e977c4f17e8e82ffc26de2fe66711cbac1cccb3e76d034414d82e22c59f"
            },
            "downloads": -1,
            "filename": "jupyterview-0.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "60c66476993bb399fadabf0e88b7fc34",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 13297546,
            "upload_time": "2022-06-23T20:21:47",
            "upload_time_iso_8601": "2022-06-23T20:21:47.531645Z",
            "url": "https://files.pythonhosted.org/packages/23/c1/68de43c26090eed7a9747f78cd37f313e4f468bc7bbdb30ffe70e0c98341/jupyterview-0.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-23 20:21:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "trungleduc",
    "github_project": "jupyterview",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jupyterview"
}
        
Elapsed time: 0.58673s