Skip to content

Commit a90bc49

Browse files
authored
Merge pull request #5 from jay-m-dev/memgraph_readme
Memgraph readme
2 parents 69d3506 + 78ccd74 commit a90bc49

File tree

1 file changed

+16
-40
lines changed

1 file changed

+16
-40
lines changed

README.md

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ AlzKB is designed and developed by the following authors (in alphabetical order)
1212
- Xi Li, MD (Cedars-Sinai)
1313
- Nick Matsumoto (Cedars-Sinai)
1414
- Jason H. Moore, PhD, FACMI (Cedars-Sinai)
15+
- Jay Moran, MS (Cedars-Sinai)
1516
- Marylyn Ritchie, PhD (UPenn)
1617
- Joseph D. Romano, PhD (UPenn)
1718
- Li Shen, PhD, FAIMBE (UPenn)
@@ -20,52 +21,27 @@ AlzKB is designed and developed by the following authors (in alphabetical order)
2021
- Paul Wang, PhD (Cedars-Sinai)
2122

2223

23-
## Prerequisites
24+
## Deprication Note
25+
Versions of AlzKB prior to v1.3.0 used Neo4j. Use of Neo4j is now depricated. Legacy versions of the knowledge graph will continue to be provided in the Releases page to support existing research.
2426

27+
## Prerequisites
28+
- Memgraph Lab (Desktop application)
29+
- Starting with AlzKB v1.3.0, Memgraph is used as the knowledge graph server.
30+
- Memgraph offers a variety of [installation options](https://memgraph.com/docs/getting-started/install-memgraph).
31+
- Memgraph Lab is the easiest way to get up and running with AlzKB. But you may use Memgraph Server if your deployment requires it.
2532
- Python (version 3.7 or later)
26-
- Instance of Neo4j with `n10s` (v4.2 or greater) plugin installed
2733

2834
## Installation
2935

3036
To build a copy of AlzKB's graph database, you can either:
31-
32-
- Download a dump of the Neo4j database and import it into Neo4j
33-
34-
- Build the knowledge base from its original third-party sources and populate
35-
an empty Neo4j graph database
36-
37-
### Install from database dump (easy)
38-
39-
- Before doing anything else, make sure you have an up-to-date version of Neo4j
40-
installed on the new database server. This can be Neo4j Desktop or Neo4j
41-
Server, depending on your intended use.
42-
43-
- Visit the [Releases page](https://github.com/EpistasisLab/AlzKB/releases) and
44-
find the version of AlzKB you want to install. Unless you have a particular
45-
reason to do otherwise, this should probably be the most recent release.
46-
Follow the link in the release notes to the corresponding database dump (it
47-
will redirect to an external page).
48-
49-
- Once you have downloaded the dump, extract the archive.
50-
51-
- If you haven't already done so, create an empty database in Neo4j.
52-
53-
- Stop any running Neo4j database instances (you can only import the dump when
54-
the destination database is shut down).
55-
56-
- Use the `neo4j-admin` utility (included with Neo4j) to import the database
57-
from the dump. You may need to add the program to your `PATH` variable or
58-
similar; if using Neo4j Desktop you can open a terminal window from within the
59-
application and use `cd bin` to access the directory where the `neo4j-admin`
60-
program is located. **(If you are installing on Neo4j Server the following
61-
command needs to be run by the appropriate user; this is often `neo4j`)**
62-
Assuming that `neo4j-admin` is accessible in your current directory, an
63-
example import command for UNIX-based operating systems could look like this
64-
(substitute database name and dump location as needed):
65-
66-
`$ neo4j-admin load --verbose --force --database=neo4j --from=~/Downloads/alzkb.dump`
67-
68-
- Start the Neo4j database and open it to verify everything looks good.
37+
- Download a copy of the latest CYPHERL file and import it into Memgraph
38+
- Build the knowledge base from its original third-party sources and import it into Memgraph
39+
40+
### Install from CYPHERL file (easy)
41+
- Visit the [Releases page](https://github.com/EpistasisLab/AlzKB/releases) and find the version of AlzKB you want to install. Unless you have a particular reason to do otherwise, this should probably be the most recent release. Follow the link in the release notes to the corresponding database dump (it will redirect to an external page).
42+
- Using Memgraph Lab, import the downloaded CYPHERL file by navigating to _Import & Export_ and then click the _Import Data_ button.
43+
- For other ways to import the CYPHERL file into a Memgraph server, see [here](https://memgraph.com/docs/data-migration/cypherl)
44+
- In Memgraph Lab, navigate to _Query execution_ to start querying the knowledge graph.
6945

7046
### Build from scratch (less easy)
7147

0 commit comments

Comments
 (0)