search

stdlib-js / jupyter-stdlib-browser-kernel

Run an in-browser JavaScript Jupyter kernel.
Apache License 2.0
7 stars 0 forks source link

readme

jupyter-stdlib-browser-kernel

Run an in-browser JavaScript Jupyter kernel.

## Prerequisites Installing and running the kernel **requires** the following prerequisites: - [Node.js][node-js]: JavaScript runtime (preferably the latest LTS version) - [npm][npm]: package manager - [Jupyter][jupyter]: notebook environment and runtime [Node.js][node-js] and [npm][npm] are only needed during the installation sequence. * * * ## Installation To install the Jupyter kernel, navigate to the user directory for installing Jupyter kernels ```bash $ cd $(jupyter --data-dir)/kernels ``` If the directory does not already exist, create the `kernels` folder ```bash $ mkdir $(jupyter --data-dir)/kernels ``` and then navigate to the created directory. Once in the `kernels` directory, clone this repository ```bash $ git clone https://github.com/stdlib-js/jupyter-stdlib-browser-kernel.git ``` Navigate to the newly created directory ```bash $ cd jupyter-stdlib-browser-kernel ``` and run the install sequence ```bash $ npm install ``` * * * ## Usage Navigate to the directory from which you want to load, save, and/or edit notebooks ```bash $ cd /path/to/directory ``` and launch Jupyter notebook ```bash $ jupyter notebook ``` Once opened, select the `JavaScript (in-browser)` notebook kernel. * * * ## Development To acquire the source code, first navigate to the parent directory into which you want to clone the git repository ```bash $ cd /path/to/parent/destination/directory ``` Next, clone the repository ```bash $ git clone https://github.com/stdlib-js/jupyter-stdlib-browser-kernel.git ``` Navigate to the newly created directory ```bash $ cd jupyter-stdlib-browser-kernel ``` and install kernel dependencies ```bash $ npm install ``` To install as a Jupyter kernel, run ```bash $ jupyter kernelspec install ./../jupyter-stdlib-browser-kernel --user ``` The previous command should be run anytime changes are made to local repository files. To run development notebooks, navigate to the `notebooks` directory ```bash $ cd notebooks ``` and launch Jupyter notebook ```bash $ jupyter notebook ``` * * * ## License See [LICENSE][license]. ## Copyright Copyright © 2019. The Stdlib Authors.
[license]: https://raw.githubusercontent.com/stdlib-js/jupyter-stdlib-browser-kernel/master/LICENSE [node-js]: https://nodejs.org/en/ [npm]: https://www.npmjs.com/ [jupyter]: https://jupyter.org/install