Code Monkey home page Code Monkey logo

jupyterlab-demo's Introduction

Installation | Documentation | Contributing | License | Team | Getting help |

PyPI version Downloads Build Status Build Status Documentation Status Crowdin GitHub Discourse Gitter Gitpod

Binder

An extensible environment for interactive and reproducible computing, based on the Jupyter Notebook and Architecture.

JupyterLab is the next-generation user interface for Project Jupyter offering all the familiar building blocks of the classic Jupyter Notebook (notebook, terminal, text editor, file browser, rich outputs, etc.) in a flexible and powerful user interface.

JupyterLab can be extended using npm packages that use our public APIs. The prebuilt extensions can be distributed via PyPI, conda, and other package managers. The source extensions can be installed directly from npm (search for jupyterlab-extension) but require an additional build step. You can also find JupyterLab extensions exploring GitHub topic jupyterlab-extension. To learn more about extensions, see the user documentation.

Read the current JupyterLab documentation on ReadTheDocs.

Important

JupyterLab 3 will reach its end of maintenance date on May 15, 2024, anywhere on Earth. To help us make this transition, fixes for critical issues will still be backported until December 31, 2024. If you are still running JupyterLab 3, we strongly encourage you to upgrade to JupyterLab 4 as soon as possible. For more information, see JupyterLab 3 end of maintenance on the Jupyter Blog.


Getting started

Installation

If you use conda, mamba, or pip, you can install JupyterLab with one of the following commands.

  • If you use conda:
    conda install -c conda-forge jupyterlab
  • If you use mamba:
    mamba install -c conda-forge jupyterlab
  • If you use pip:
    pip install jupyterlab
    If installing using pip install --user, you must add the user-level bin directory to your PATH environment variable in order to launch jupyter lab. If you are using a Unix derivative (e.g., FreeBSD, GNU/Linux, macOS), you can do this by running export PATH="$HOME/.local/bin:$PATH". If you are using a macOS version that comes with Python 2, run pip3 instead of pip.

For more detailed instructions, consult the installation guide. Project installation instructions from the git sources are available in the contributor documentation.

Installing with Previous Versions of Jupyter Notebook

When using a version of Jupyter Notebook earlier than 5.3, the following command must be run after installing JupyterLab to enable the JupyterLab server extension:

jupyter serverextension enable --py jupyterlab --sys-prefix

Running

Start up JupyterLab using:

jupyter lab

JupyterLab will open automatically in the browser. See the documentation for additional details.

If you encounter an error like "Command 'jupyter' not found", please make sure PATH environment variable is set correctly. Alternatively, you can start up JupyterLab using ~/.local/bin/jupyter lab without changing the PATH environment variable.

Prerequisites and Supported Browsers

The latest versions of the following browsers are currently known to work:

  • Firefox
  • Chrome
  • Safari

See our documentation for additional details.


Getting help

We encourage you to ask questions on the Discourse forum. A question answered there can become a useful resource for others.

Bug report

To report a bug please read the guidelines and then open a Github issue. To keep resolved issues self-contained, the lock bot will lock closed issues as resolved after a period of inactivity. If a related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.

Feature request

We also welcome suggestions for new features as they help make the project more useful for everyone. To request a feature please use the feature request template.


Development

Extending JupyterLab

To start developing an extension for JupyterLab, see the developer documentation and the API docs.

Contributing

To contribute code or documentation to JupyterLab itself, please read the contributor documentation.

JupyterLab follows the Jupyter Community Guides.

License

JupyterLab uses a shared copyright model that enables all contributors to maintain the copyright on their contributions. All code is licensed under the terms of the revised BSD license.

Team

JupyterLab is part of Project Jupyter and is developed by an open community. The maintenance team is assisted by a much larger group of contributors to JupyterLab and Project Jupyter as a whole.

JupyterLab's current maintainers are listed in alphabetical order, with affiliation, and main areas of contribution:

  • Mehmet Bektas, Netflix (general development, extensions).
  • Alex Bozarth, IBM (general development, extensions).
  • Eric Charles, Datalayer, (general development, extensions).
  • Frédéric Collonval, WebScIT (general development, extensions).
  • Martha Cryan, Mito (general development, extensions).
  • Afshin Darian, QuantStack (co-creator, application/high-level architecture, prolific contributions throughout the code base).
  • Vidar T. Fauske, JPMorgan Chase (general development, extensions).
  • Brian Granger, AWS (co-creator, strategy, vision, management, UI/UX design, architecture).
  • Jason Grout, Databricks (co-creator, vision, general development).
  • Michał Krassowski, Quansight (general development, extensions).
  • Max Klein, JPMorgan Chase (UI Package, build system, general development, extensions).
  • Gonzalo Peña-Castellanos, QuanSight (general development, i18n, extensions).
  • Fernando Perez, UC Berkeley (co-creator, vision).
  • Isabela Presedo-Floyd, QuanSight Labs (design/UX).
  • Steven Silvester, MongoDB (co-creator, release management, packaging, prolific contributions throughout the code base).
  • Jeremy Tuloup, QuantStack (general development, extensions).

Maintainer emeritus:

  • Chris Colbert, Project Jupyter (co-creator, application/low-level architecture, technical leadership, vision, PhosphorJS)
  • Jessica Forde, Project Jupyter (demo, documentation)
  • Tim George, Cal Poly (UI/UX design, strategy, management, user needs analysis).
  • Cameron Oelsen, Cal Poly (UI/UX design).
  • Ian Rose, Quansight/City of LA (general core development, extensions).
  • Andrew Schlaepfer, Bloomberg (general development, extensions).
  • Saul Shanabrook, Quansight (general development, extensions)

This list is provided to give the reader context on who we are and how our team functions. To be listed, please submit a pull request with your information.


Weekly Dev Meeting

We have videoconference meetings every week where we discuss what we have been working on and get feedback from one another.

Anyone is welcome to attend, if they would like to discuss a topic or just listen in.

Notes are archived on GitHub Jupyter Frontends team compass.

jupyterlab-demo's People

Contributors

afshin avatar akhmerov avatar axiezai avatar blink1073 avatar bollwyvl avatar carreau avatar ddavidebor avatar dharmaquark avatar ellisonbg avatar ericcousineau-tri avatar fcollonval avatar fperez avatar github-actions[bot] avatar gnestor avatar ian-r-rose avatar jasongrout avatar jtpio avatar jzf2101 avatar kirstiejane avatar krassowski avatar mariusvniekerk avatar minrk avatar sylvaincorlay avatar thewbear avatar yuvipanda avatar zsailer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jupyterlab-demo's Issues

#31 change copyright date.

#31 change Copyright date from 2016 to 2017. IIRC the copyright date should be the date of first copyright and is implicitly YYYY-Present. Should it be changed back ? @ellisonbg ?

Install kernels for demos

I don't think that the invoke commands install the kernels for the julia and R notebooks.

Either document that they need to be installed separately or install if possible.

solving environment failed

Tried 'invoke environment' inside the repo directory using:
miniconda 4.5.11
python 3.6.5

invoke environment fails with the following messages:
Solving environment: failed

UnsatisfiableError: The following specifications were found to be in conflict:

  • scikit-learn=0.18
  • xtensor-blas=0.12
    Use "conda info " to see the dependencies for each package.

Any help is appreciated!

Build is failing

Looks like the last build has not been passing in Travis with:

AttributeError: module 'tornado.web' has no attribute 'asynchronous' 

Possibly related to:
conda-forge/nbconvert-feedstock#27

Note that that currently this repo does not work on binder (running notebook simply hangs)

Merge Fork?

@jasongrout @ellisonbg : @fperez asked me to use this demo to start putting together initial user documentation for lab. I can't write issues on the forks, but since @jasonsgrout 's fork is far ahead, is it possible we could PR the forks?

`INSTALL.txt` errors

@jasongrout

Invalid requirement: 'bqplot=0.9.0b10' = is not a valid operator. Did you mean == ?

- Writing config: /Users/4d/anaconda/envs/jlabdemo/etc/jupyter/labconfig X is not version compatible with installed JupyterLab version 0.16.2 Expects JupyterLab version ^0.13.1 from packaged module [email protected]/lib/widget.js Expects JupyterLab version ^0.13.1 from packaged module [email protected]/lib/plugin.js

Collecting dask-labextensions Could not find a version that satisfies the requirement dask-labextensions (from versions: ) No matching distribution found for dask-labextensions

Install JupyterLab renderers with conda

Once conda-forge/staged-recipes#14245 is merged and the packages available on conda, we should be able to remove this task:

jupyterlab-demo/tasks.py

Lines 44 to 57 in 5a5eb6b

@task
def build(ctx, env_name=env_name, kernel=True):
'''
Builds an environment with appropriate extensions.
'''
ctx.run("""
{0!s} activate {1!s} &&
jupyter labextension install @jupyterlab/[email protected] --no-build &&
jupyter labextension install @jupyterlab/[email protected] --no-build &&
jupyter lab clean && jupyter lab build --dev-build=False --minimize=False
""".format(source, env_name).strip().replace('\n', ''))
if kernel:
ctx.run("{0!s} activate {1!s} && ipython kernel install --name {1!s} --display-name {1!s} --sys-prefix".format(source, env_name))

And add the dependencies to:

Which should make the Binder build faster.

Missing some datafiles

I tried to get the demos working for a presentation this morning. Even after using invoke to install the data files, the files could not be found. Are some of the datafiles missing? Or is it a path issue on my part?

Failed to create the environment - Can't find any collection named 'tasks'!

Using:

  • Windows 10
  • Miniconda
  • Anaconda Prompt to run conda
(base) C:\>conda --version
conda 4.4.10

Installation was ended successfully

(base) C:\>conda install -c conda-forge invoke pyyaml
Solving environment: done

# All requested packages already installed.

But creating the environment failed -

(base) C:\>invoke environment
Can't find any collection named 'tasks'!

Thanks.

WebSocket error 502 on mybinder.org

I'm getting this result from chrome console on mybinder.org when notebook is trying to connect to kernel.

WebSocket connection to 'wss://hub.mybinder.org/user/jupyterlab-jupyterlab-demo-azimq5mq/api/kernels/267f4698-ce2a-443d-aab9-46bd61a49ffb/channels?session_id=8d0e4978-7cb6-4184-82b3-4bf6fa323698&token=Qy1Nd1A6RDWoJEL5lUqo_w' failed: Error during WebSocket handshake: Unexpected response code: 502

Meanwhile, the top right status dot keeps showing Kernel Reconnecting.

When I visit the normal notebook (path: /notebooks/demo/Lorenz.ipynb), 500 : Internal Server Error is returned.

'touch' is not recognized as an internal or external command, operable program or batch file.

Running on Windows -

(base) C:\Code\jupyterlab-demo>invoke demofiles
cleaning demofiles
creating demofolder
cloning repos into demo folder demofiles
Cloning into 'PythonDataScienceHandbook'...
Cloning into 'Urban-Data-Challenge'...
Cloning into 'altair'...
Cloning into 'QuantEcon.notebooks'...
Cloning into 'TCGA'...
Cloning into 'TensorFlow-Examples'...
Cloning into 'bqplot'...
'touch' is not recognized as an internal or external command,
operable program or batch file.

It happens because this line:
ctx.run('touch move_this_file.txt; mkdir move_it_here')

'touch' program, doesn't exists in Windows, that why it fails.

Maybe, the code can be updated to check if it is Windows,
and run equivalent command, like:
type nul > move_this_file.txt

The same way the code does for rmdir.

Thanks

Geojson of lightning strikes

We could include a geojson file of lightning strikes, and maybe a large csv of them, you know, for lightning talks :). It'd be fun to give a talk where the data was all puns on lightning talks.

Test Invoke Scripts on Windows?

Based on the documentation I've read so far from invoke, it's unclear to me if the shell commands in the invoke script will run on Windows. Could someone confirm?

yml profiles

@willingc @ellisonbg @jasongrout Based on an earlier conversation, we think it would make sense to have profiles for different talks in a yml file. An invoke script would copy relevant files into a folder for the talk. This way we can customize talks to different audiences.

Repository got banned from mybinder.org

Hello from mybinder.org,

we had a bit of a rough evening since you merged #73. We aren't quite sure why this caused us problems or what is wrong with the build for this repository. However we observed very high CPU load, and eventually noticed that lots of ipython demo pods were running but none from jupyterlab. The first time our CPU usage went through the roof was exactly when you merged #73. So for the moment we banned this repository. After the first few minutes it seems like this resolved our problem.

You can try and build the repository locally with repo2docker or making a fork which should not be banned.

You can find us on gitter: https://gitter.im/jupyterhub/binder or we discuss in this issue

ResolvePackageNotFound: - xeus-cling[version='<=0.11']

"invoke environment" fails:

(base) <repo>\jupyterlab-demo-master>invoke environment --env-name=jupyterlab-demo
creating environment jupyterlab-demo
Collecting package metadata (repodata.json): ...working... done
Solving environment: ...working... failed

ResolvePackageNotFound:
  - xeus-cling[version='<=0.11']

btw:

(base) ... >conda config --add channels conda-forge --yes
usage: conda-script.py [-h] [-V] command ...
conda-script.py: error: unrecognized arguments: --yes

Installation vs Makefile

Per suggestion from @fperez , I tried installing the fork from @jasongrout but make demo doesn't handle the environment setup from INSTALL.txt Should there be changes to the makefile or readme to take care of environment setup for the demo?

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.