Diff of /setup_guide.md [000000] .. [7d5693]

Switch to unified view

a b/setup_guide.md
1
# Plotly
2
3
To make plotly plot shows up in jupyterlab:
4
5
$ jupyter labextension install jupyterlab-plotly
6
7
# Reactome Setup Guide
8
9
The following are the instructions to get Reactome running on Ubuntu 18.04. For other OS, please refer to the official Neo4j documentation.
10
11
### 1. Install Java 8
12
13
Neo4j specifically requires Java 8 to be installed. If you don't have Java installed, you can install it with the command below:
14
```bash
15
$ sudo apt install openjdk-8-jdk
16
```
17
Otherwise validate that you have Java 8 installed:
18
```bash
19
$ java -version
20
openjdk version "1.8.0_181"
21
```
22
23
### 2. Install Neo4j Community Edition
24
25
[Linux Installation - Neo4j Reference](https://neo4j.com/docs/operations-manual/current/installation/linux/debian/?_ga=2.249168388.2041192375.1507250087-893468657.1507250087).
26
27
Run the following commands to install Neo4j Community Edition 3.4.6:
28
```bash
29
$ wget -O - https://debian.neo4j.org/neotechnology.gpg.key | sudo apt-key add -
30
$ echo 'deb https://debian.neo4j.org/repo stable/' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
31
$ sudo apt-get update
32
$ sudo apt-get install neo4j=1:3.4.6
33
```
34
Later version of Neo4j can also be used, as long as it is version 3 (version 4 seems to have problems with Reactome database).
35
36
Verify that Neo4j is running:
37
```bash
38
$ sudo service neo4j status
39
```
40
From the status above, you can see that $NEO4J_HOME is located at `/var/lib/neo4j`. 
41
If Neo4j is not running, start it:
42
```bash
43
$ sudo service neo4j start
44
```
45
46
Once it's running, [set the initial password](https://stackoverflow.com/questions/47530154/neo4j-command-failed-initial-password-was-not-set-because-live-neo4j-users-wer) to whatever you prefer.
47
```bash
48
$ curl -H "Content-Type: application/json" -X POST -d '{"password":"WHATEVER THE PASSWORD IS"}' -u neo4j:neo4j http://localhost:7474/user/neo4j/password
49
```
50
51
### 3. Install Reactome database
52
53
See https://reactome.org/dev/graph-database
54
55
Download the Reactome database. Extract and move it to `$NEO4J_HOME/data/databases`.
56
```bash
57
$ wget https://reactome.org/download/current/reactome.graphdb.tgz
58
$ tar xvzf reactome.graphdb.tgz
59
$ sudo mv graph.db /var/lib/neo4j/data/databases
60
$ chown -R neo4j:neo4j /var/lib/neo4j/data/databases/graph.db
61
```
62
Edit the config file at either `$NEO4J_HOME/conf/neo4j.conf` or `/etc/neo4j/neo4j.conf`. 
63
Change ```dbms.active_database``` to ```dbms.active_database=graph.db``` if necessary.
64
65
Check that the neo4j service is running with the following command. If it is not running, start it.
66
```bash
67
$ sudo service neo4j status
68
```
69
70
For graph database connection in PALS, be sure to set the following environmental variables:
71
- `NEO4J_SERVER`: your Neo4j server (default: bolt://localhost:7687)
72
- `NEO4J_USER`: your Neo4j user name (default: neo4j)
73
- `NEO4J_PASSWORD`: your Neo4j password (default: neo4j)