Permalink
Newer
Older
100644 101 lines (75 sloc) 3.59 KB
Aug 17, 2015 @ibab Add initial commit
1
Aug 18, 2015 @ibab Fix headings
2 # everware
Aug 17, 2015 @ibab Add initial commit
3
Mar 7, 2016 @betatim README was quite old
4 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/everware/everware)
5 [![Build Status](https://travis-ci.org/everware/everware.svg?branch=master)](https://travis-ci.org/everware/everware)
Sep 30, 2015 @betatim Added gitter badge
6
Mar 7, 2016 @betatim README was quite old
7 **Everware is about re-useable science, it allows people to jump right
8 in to your research code.**
Aug 18, 2015 @ibab Add more explanations
9
Mar 7, 2016 @betatim README was quite old
10 It lets you launch [Jupyter](https://jupyter.org) notebooks from a git
11 repository with a click of a button. Everware is an extension for
12 [JupyterHub]. The main component is a spawner that allows you to spawn
13 custom docker images.
Aug 18, 2015 @ibab Add more explanations
14
Mar 7, 2016 @betatim README was quite old
15 Checkout the **[ROADMAP](../../issues/39)** to see where we are going
16 and how to get involved with the project.
Aug 18, 2015 @ibab Add more explanations
17
Mar 7, 2016 @betatim README was quite old
18 See [this blog
19 post](http://betatim.github.io/posts/project-everware-reusable-science/)
20 for more information about what `everware` is and how it can be useful.
21
22 The idea for everware originated at the CERN Webfest 2015. The
23 original everware team consists of
24 [@OmeGak](https://github.com/omegak),
25 [@ibab](https://github.com/ibab), [@ndawe](https://github.com/ndawe),
26 [@betatim](https://github.com/betatim),
27 [@uzzielperez](https://github.com/uzzielperez),
28 [@anaderi](https://github.com/anaderi), and
29 [@AxelVoitier](https://github.com/AxelVoitier).
Aug 18, 2015 @ibab Add more explanations
30
Mar 17, 2016 @betatim Updating install instructions and splitting config files
31
Sep 20, 2015 @betatim Link to docs
32 ## Documentation
33
Mar 7, 2016 @betatim README was quite old
34 We have some documentation on the different ways to use `everware` and
35 [getting
36 started](https://github.com/everware/everware/wiki/Getting-Started).
Sep 20, 2015 @betatim Link to docs
37
Mar 17, 2016 @betatim Updating install instructions and splitting config files
38
Mar 6, 2016 @betatim How to get selenium
39 ## Try it out
Aug 18, 2015 @ibab Add more explanations
40
Mar 7, 2016 @betatim README was quite old
41 In order to deploy your own `everware` instance, you have to:
Aug 18, 2015 @ibab Update README.md with more precise instructions
42
Aug 25, 2016 @anaderi Add installation of node step
43 - install `nodejs` and `npm` (platform-specific)
Jan 27, 2017 @malchun Fix README, update version, update jupyterhub to 0.7.2.
44 - create and activate a `conda` environment with python 3.5(or 3.6.0)
Aug 18, 2015 @betatim Expanding the install instructions
45 ```
Mar 17, 2016 @betatim Updating install instructions and splitting config files
46 conda create -n everware python=3.5
Jun 25, 2016 @amitkumarj441 Update README.md
47 source activate everware
Aug 18, 2015 @betatim Expanding the install instructions
48 ```
Mar 17, 2016 @betatim Updating install instructions and splitting config files
49 - Clone this repo and install `everware`
Aug 18, 2015 @betatim Expanding the install instructions
50 ```
51 git clone https://github.com/everware/everware
52 cd everware
Mar 17, 2016 @betatim Updating install instructions and splitting config files
53 make install
Aug 18, 2015 @betatim Expanding the install instructions
54 ```
Mar 17, 2016 @betatim Updating install instructions and splitting config files
55 - [Create a Github OAuth application](https://github.com/settings/applications/new)
56 with URL `http://localhost:8000/` and callback URL
57 `http://localhost:8000/hub/oauth_callback`
58 - Enter you OAuth information into `env.sh` and `source env.sh`. You will
59 have to set these environment variables every time before running `everware`
60
61 - If you are on **Mac OS** make sure the VM in which docker runs is
62 started (`docker-machine start <vm-name>`) and your environment is
63 setup properly (`docker-machine env <vm-name>`). Start `everware` with:
Aug 17, 2015 @ibab Add instructions
64 ```
Mar 17, 2016 @betatim Updating install instructions and splitting config files
65 everware-server -f etc/local_dockermachine_config.py --debug --no-ssl
Aug 18, 2015 @ibab Clean up install instructions
66 ```
Jan 27, 2017 @malchun Fix README, update version, update jupyterhub to 0.7.2.
67 - If you are on **Linux** make sure `dockerd` is running, your user
68 is in docker group and your environment contains the required
69 information (`DOCKER_HOST` is set, etc). Then start `everware` with
Aug 18, 2015 @ibab Clean up install instructions
70 ```
Mar 17, 2016 @betatim Updating install instructions and splitting config files
71 everware-server -f etc/local_config.py --debug --no-ssl
Aug 17, 2015 @ibab Add instructions
72 ```
73
May 19, 2017 @vchagaev fix link to docker.md
74 Everware can also be deployed in a Docker container. See [Everware in Docker container](docs/docker.md)
Apr 27, 2016 @BertrandNOEL Documentation
75
Mar 17, 2016 @betatim Updating install instructions and splitting config files
76
Mar 6, 2016 @betatim How to get selenium
77 ## Development
78
Mar 17, 2016 @betatim Updating install instructions and splitting config files
79 Follow the instructions for deploying your own everware instance. In
80 addition to run our tests you will need [selenium] and [firefox]. On
81 OS X you can install selenium with:
Mar 6, 2016 @betatim How to install phantomjs
82
83 ```
84 brew install selenium-server-standalone
85 ```
86
Mar 17, 2016 @betatim Updating install instructions and splitting config files
87 _Note:_ if you are not starting from an environment that already contains
88 [dockerspawner] make sure it is updated to the right commit. `pip` will
89 be satisfied if it is installed which might leave you with an old version.
Mar 18, 2016 @anaderi revert -U, added 'Final remarks'
90
91
Mar 6, 2016 @betatim How to install phantomjs
92 [selenium]: http://www.seleniumhq.org/
Mar 18, 2016 @anaderi revert -U, added 'Final remarks'
93 [jupyterhub]: https://github.com/jupyter/jupyterhub
Mar 17, 2016 @betatim Updating install instructions and splitting config files
94 [dockerspawner]: https://github.com/jupyter/dockerspawner
95 [firefox]: https://www.mozilla.org/en-US/firefox/
Mar 7, 2017 @anaderi slides & paper links added
96
97 ## More information
98
Mar 7, 2017 @anaderi slides link fixed
99 Slides (2016-10): https://speakerdeck.com/anaderi/everware-toolkit-supporting-reproducible-science-and-challenge-driven-education
Mar 7, 2017 @anaderi slides & paper links added
100
101 Paper (2017-02): https://arxiv.org/abs/1703.01200