Giter Club home page Giter Club logo

jupyterlab_voyager's Introduction

jupyterlab_voyager

npm Build Status Binder

A JupyterLab MIME renderer extension to view CSV and JSON data in Voyager 2.

Screen shot showing data file opened in Voyager in JupyterLab

Prerequisites

  • JupyterLab

Installation

jupyter labextension install jupyterlab_voyager

You can also use this with the Docker base images:

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

- 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:

yarn install
jupyter labextension link .

Then build the files and start Jupyter Lab:

yarn watch
# in new window
jupyter lab --port=8889 --watch

Reload the page to see new code changes.

Testing

First install cypress:

npm install -g [email protected]

Then you can run the tests:

cypress run

Or open Cypress for an interactive experience:

cypress open

Docker

If you have Docker version >= 17.09.0-ce installed, you can also do all of the above with:

docker-compose up lab

Then you can run the tests with:

docker-compose run --rm test

If you change the installed packages, you have to remove the existing volume and rebuild the images:

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.

jupyterlab_voyager's People

Contributors

ellisonbg avatar gnestor avatar saulshanabrook avatar zzhangjii avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.