everware

Everware is about re-useable science, it allows people to jump right in to your research code.

It lets you launch Jupyter notebooks from a git repository with a click of a button. Everware is an extension for JupyterHub. The main component is a spawner that allows you to spawn custom docker images.

Checkout the ROADMAP to see where we are going and how to get involved with the project.

See this blog post for more information about what everware is and how it can be useful.

The idea for everware originated at the CERN Webfest 2015. The original everware team consists of @OmeGak, @ibab, @ndawe, @betatim, @uzzielperez, @anaderi, and @AxelVoitier.

Documentation

We have some documentation on the different ways to use everware and getting started.

Try it out

In order to deploy your own everware instance, you have to:

Install the newest git version of jupyterhub: https://github.com/jupyter/jupyterhub. Double check with their README.md

    sudo apt-get install npm nodejs-legacy
    sudo npm install -g configurable-http-proxy
    git clone https://github.com/jupyter/jupyterhub.git
    cd jupyterhub
    pip3 install -r dev-requirements.txt -e .

Install the newest git version of dockerspawner: https://github.com/jupyter/dockerspawner. Double check with their README.md

    git clone https://github.com/jupyter/dockerspawner.git
    cd dockerspawner
    pip3 install -e .

Clone this repo

    git clone https://github.com/everware/everware
    cd everware

Create a Github OAuth application with URL http://localhost:8000/ and callback URL http://localhost:8000/hub/oauth_callback
Enter you OAuth information into env.sh and source env.sh
Install everware

    pip3 install -e .

If you are not using boot2docker, but run directly on Linux, edit jupyterhub_config.py as indicated in the file.
Run

    jupyterhub

Development

To run our tests you will need selenium and phantomjs. On OS X you can install them with:

brew install selenium-server-standalone
brew install phantomjs