Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/altair-viz/jupyterlab_voyager
JupyterLab extension visualize data with Voyager
https://github.com/altair-viz/jupyterlab_voyager
jupyterlab jupyterlab-extension vega
Last synced: 3 months ago
JSON representation
JupyterLab extension visualize data with Voyager
- Host: GitHub
- URL: https://github.com/altair-viz/jupyterlab_voyager
- Owner: altair-viz
- License: bsd-3-clause
- Created: 2017-08-26T15:50:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T19:48:00.000Z (about 2 years ago)
- Last Synced: 2024-07-31T23:39:46.699Z (6 months ago)
- Topics: jupyterlab, jupyterlab-extension, vega
- Language: TypeScript
- Homepage:
- Size: 10.6 MB
- Stars: 297
- Watchers: 20
- Forks: 35
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyterlab - voyager - A JupyterLab MIME renderer extension to view CSV and JSON data in [Voyager 2](https://github.com/vega/voyager#voyager-2). (Uncategorized / Uncategorized)
- awesome-jupyter-resources - GitHub - 66% open · ⏱️ 14.08.2019): (JupyterLab渲染器)
- awesome-starred - altair-viz/jupyterlab_voyager - JupyterLab extension visualize data with Voyager (others)
README
# jupyterlab_voyager
[](https://www.npmjs.com/package/jupyterlab_voyager)
[](https://travis-ci.org/altair-viz/jupyterlab_voyager)
[](https://mybinder.org/v2/gh/altair-viz/jupyterlab_voyager/master?urlpath=lab)
A JupyterLab MIME renderer extension to view CSV and JSON data in [Voyager 2](https://github.com/vega/voyager#voyager-2).
## Prerequisites
* JupyterLab
## Installation
```bash
jupyter labextension install jupyterlab_voyager
```
You can also use this with the Docker base images:
```Dockerfile
FROM jupyter/minimal-notebook
RUN jupyter labextension install jupyterlab_voyager
CMD start.sh jupyter lab
```
Then right click on any `csv`, `tsv` or `json` file click "Open with...", then "Voyager".
If you experience
```"FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory"```
error during installation, you can use
```bash
- export NODE_OPTIONS=--max-old-space-size=16000
```
or just add NODE_OPTIONS=--max-old-space-size=16000 env variable when
running jupyter lab build to solve this problem.
## Development
For a development install (requires npm version 4 or later, yarn, and jupyterlab), do the following in the repository directory:
```bash
yarn install
jupyter labextension link .
```
Then build the files and start Jupyter Lab:
```bash
yarn watch
# in new window
jupyter lab --port=8889 --watch
```
Reload the page to see new code changes.
### Testing
You can run the E2E tests with cypress:
```bash
jupyter lab --port=8889
# in a new window
npx cypress run
```
Or open Cypress for an interactive experience:
```bash
npx cypress open
```
## Docker
If you have Docker version >= 17.09.0-ce installed, you can also do all of the above with:
```bash
docker-compose up lab
```
Then you can run the tests with:
```bash
docker-compose run --rm test
```
If you change the installed packages, you have to remove the existing volume and rebuild the images:
```bash
docker-compose down -v
docker-compose build
```
## Future Work
This extension provides a bare minimum integration with Voyager. It would be great to
support features like:
* Save Voyager state in widget, so that when window is reloaded it will preserve what
you have selected.
* Allow viewing Pandas dataframes in the notebook with Voyager.
*Created using [JupyterLab `extension-cookiecutter-ts`](https://github.com/jupyterlab/extension-cookiecutter-ts)*.