# jupyter-vcdat > A vCDAT extension for JupyterLab. Latest version **2.3.5** (published 2020-05-15) · BSD-3-Clause license · 0 weekly downloads ## Install ```sh npm install jupyter-vcdat pnpm add jupyter-vcdat yarn add jupyter-vcdat bun add jupyter-vcdat ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.3.5 | | Published | 2020-05-15 | | First published | 2019-06-13 | | Weekly downloads | 0 | | License | BSD-3-Clause | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 38 | | Unpacked size | 866.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 6 | | Author | LLNL CDAT team | | Maintainers | doutriaux1, downie4 | | Keywords | jupyter, jupyterlab, jupyterlab-extension | ## Links - npm: https://www.npmjs.com/package/jupyter-vcdat - Repository: https://github.com/CDAT/jupyter-vcdat - Issues: https://github.com/CDAT/jupyter-vcdat.git/issues - npm.io page: https://npm.io/package/jupyter-vcdat ## Dependencies (38) - [react](https://npm.io/package/react.md) ~16.9.0 - [jquery](https://npm.io/package/jquery.md) ^3.4.1 - [lodash](https://npm.io/package/lodash.md) ^4.17.15 - [moment](https://npm.io/package/moment.md) ^2.24.0 - [remove](https://npm.io/package/remove.md) ^0.1.5 - [bootstrap](https://npm.io/package/bootstrap.md) ^4.4.1 - [rc-slider](https://npm.io/package/rc-slider.md) ^9.2.4 - [react-dom](https://npm.io/package/react-dom.md) ~16.9.0 - [ts-dedent](https://npm.io/package/ts-dedent.md) ^1.1.1 - [react-list](https://npm.io/package/react-list.md) ^0.8.13 - [reactstrap](https://npm.io/package/reactstrap.md) ^8.4.1 - [query-string](https://npm.io/package/query-string.md) ^6.12.1 - [react-joyride](https://npm.io/package/react-joyride.md) ^2.2.1 - [react-toastify](https://npm.io/package/react-toastify.md) ^5.5.0 - [@lumino/widgets](https://npm.io/package/@lumino/widgets.md) ^1.11.1 - [@lumino/commands](https://npm.io/package/@lumino/commands.md) ^1.10.1 - [bootstrap-slider](https://npm.io/package/bootstrap-slider.md) ^10.6.2 - [@jupyterlab/cells](https://npm.io/package/@jupyterlab/cells.md) ^2.1.0 - [@lumino/algorithm](https://npm.io/package/@lumino/algorithm.md) ^1.2.3 - [@lumino/coreutils](https://npm.io/package/@lumino/coreutils.md) ^1.4.2 - [@lumino/messaging](https://npm.io/package/@lumino/messaging.md) ^1.3.3 - [@lumino/signaling](https://npm.io/package/@lumino/signaling.md) ^1.3.5 - [react-html-parser](https://npm.io/package/react-html-parser.md) ^2.0.2 - [react-load-script](https://npm.io/package/react-load-script.md) 0.0.6 - [@lumino/disposable](https://npm.io/package/@lumino/disposable.md) ^1.3.5 - [autobind-decorator](https://npm.io/package/autobind-decorator.md) ^2.4.0 - [@jupyterlab/console](https://npm.io/package/@jupyterlab/console.md) ^2.1.0 - [jupyterlab-tutorial](https://npm.io/package/jupyterlab-tutorial.md) ^1.0.5 - [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) ^2.1.0 - [@jupyterlab/mainmenu](https://npm.io/package/@jupyterlab/mainmenu.md) ^2.1.0 - [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) ^2.1.0 - [@jupyterlab/services](https://npm.io/package/@jupyterlab/services.md) ^5.1.0 - [@jupyterlab/coreutils](https://npm.io/package/@jupyterlab/coreutils.md) ^4.1.0 - [react-compound-slider](https://npm.io/package/react-compound-slider.md) ^2.5.0 - [@jupyterlab/outputarea](https://npm.io/package/@jupyterlab/outputarea.md) ^2.1.0 - [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^2.1.0 - [@jupyterlab/docregistry](https://npm.io/package/@jupyterlab/docregistry.md) ^2.1.0 - [@jupyterlab/filebrowser](https://npm.io/package/@jupyterlab/filebrowser.md) ^2.1.0 ## Recent versions - 2.3.5 (latest) — 2020-05-15 - 2.3.9 (nightly) — 2020-11-04 - 2.0.1 (rgma) — 2019-07-17 - 2.3.8 — 2020-10-27 - 2.3.7 — 2020-10-27 - 2.3.6 — 2020-10-23 - 2.3.4 — 2020-05-09 - 2.3.3 — 2020-04-29 - 2.3.2 — 2020-04-23 - 2.3.1 — 2020-03-20 - 2.3.0 — 2020-02-25 - 2.2.3 — 2020-01-31 - 2.2.2 — 2020-01-13 - 2.2.1 — 2019-12-13 - 2.2.1-demo6 — 2019-11-27 - … 19 more at https://npm.io/package/jupyter-vcdat/versions ## README [![DOI](https://zenodo.org/badge/147574270.svg)](https://zenodo.org/badge/latestdoi/147574270) # Jupyter-vcdat A Jupyter Lab extension that integrates vCDAT features directly in a notebook. ## Prerequisites ### For installing locally with conda you'll need: - Installation of conda via Anaconda or Miniconda conda >=4.7.12 (the script will try to update your base installation anyway) If you didn't let Anaconda or Miniconda prepend the Anaconda(2 or 3) install location to PATH, make sure conda is in your PATH (for more information see the [Anaconda Documentation](https://docs.anaconda.com/anaconda/user-guide/faq/#installing-anaconda)). Assuming Ananconda is installed in ${HOME}/anaconda: * export PATH=${HOME}/anaconda/bin:${PATH} # for bash * setenv PATH ${HOME}/anaconda/bin:${PATH} # for tcsh ### For running docker container, you'll need docker installed: - Installing Docker: https://docs.docker.com/v17.09/engine/installation/ ## User Installation You can run jupyter-vcdat via a local installation, an anaconda environment or through a docker container. ### New conda environment This example will create and run a new conda environment 'jupyter-vcdat', containing JupyterLab and jupyter-vcdat ```bash conda create -n jupyter-vcdat -c cdat/label/v82 -c conda-forge jupyter-vcdat #Create conda environment conda activate jupyter-vcdat #Start environment jupyter lab build #Build jupyter lab to include jupyter-vcdat extension (only for first time installation) jupyter lab #Start Jupyter Lab ``` The browser should open automatically, if not, point your browser to: localhost:8888/lab ### Existing conda environment This example will install jupyter-vcdat to an existing conda environment. * Note: python3 is required and will be installed. ```bash conda install -c cdat/label/v82 -c conda-forge jupyter-vcdat #Install jupyter-vcdat jupyter lab build #Build jupyter lab to include jupyter-vcdat extension (only for first time installation) jupyter lab #Start Jupyter Lab ``` The browser should open automatically, if not, point your browser to: localhost:8888/lab ### Jupyter-vcdat docker container This example runs a jupyter-vcdat docker container at localhost:9000/lab, with mounted volume 'my_data': ```bash docker run -p 9000:8888 -v /Path/To/my_data/:/home/jovyan/my_data/ -it cdat/vcdat:latest jupyter lab #Run the image ``` After the container is running, obtain the token (if needed) from the output shown in the console: ```bash The Jupyter Notebook is running at: http://(d8a71c79a232 or 127.0.0.1):8888/?token= ``` Open a browser and use this URL: ### localhost:8888/lab?token=\ You should then be able to access the jupyter lab instance on your local browser. ## Obtaining sample data To download sample data, enter the code below within a Jupyter notebook cell and run the cell: ```python import vcs import cdms2 import cdat_info import pkg_resources vcs_egg_path = pkg_resources.resource_filename(pkg_resources.Requirement.parse("vcs"), "share/vcs") path = vcs_egg_path+'/sample_files.txt' cdat_info.download_sample_data_files(path,"sample_data") ``` ## Local installation (for developers) Make sure you have met all pre-requisits noted at the top. Clone the jupyter-vcdat github repo: ```bash git clone https://github.com/CDAT/jupyter-vcdat.git ``` Change into the directory containing the repo and type in the following commands: ```bash #Create the environment ./install_script.sh #Note: You can use -h to get help and options for installation script. # The following two lines of code install tslint if developers want to use it (optional): # For VSCode: code --install-extension tslint # For Atom: apm install linter-tslint # For all users, activate the jupyter-vcdat environment and launch the JupyterLab interface conda activate jupyter-vcdat jupyter lab ``` To rebuild the package and the JupyterLab app: ```bash npm run build jupyter lab build ``` * For more information on getting started with Jupyter-VCDAT checkout the [Getting Started Page](https://github.com/CDAT/jupyter-vcdat/wiki/Getting-Started). --- _Source: https://npm.io/package/jupyter-vcdat · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._