Skip to content

Commit b312115

Browse files
committed
Write skeleton readme
1 parent 11ac054 commit b312115

File tree

2 files changed

+44
-1
lines changed

2 files changed

+44
-1
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
11
# AlzKB
2+
3+
A knowledge base for AI research in Alzheimer Disease, based on graph databases.
4+
5+
### Authors
6+
7+
AlzKB is designed and developed by the following authors (in alphabetical order):
8+
9+
- Yun Hao (UPenn)
10+
- Jason H. Moore, PhD, FACMI (Cedars-Sinai)
11+
- Joseph D. Romano, PhD (UPenn)
12+
- Li Shen, PhD (UPenn)
13+
- Van Truong (UPenn)
14+
15+
## Prerequisites
16+
17+
- Python (version 3.7 or later)
18+
- Instance of Neo4j with `n10s` (v4.2 or greater) plugin installed
19+
20+
## Installation
21+
22+
(Note: Implementation not yet complete)
23+
24+
Install AlzKB:
25+
```{bash}
26+
$ pip install .
27+
```
28+
29+
Download public data sources:
30+
```{bash}
31+
$ alzkb bootstrap
32+
```
33+
34+
Build the RDF/XML knowledge base
35+
```{bash}
36+
$ alzkb build
37+
```
38+
39+
Install knowledge base to an instance of Neo4j
40+
```{bash}
41+
$ alzkb install
42+
```

setup.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@
2424
include_package_data=True,
2525
entry_points={
2626
'console_scripts': [
27-
'build_alzkb=alzkb.build.db:main'
27+
'alzkb-bootstrap=alzkb.build.bootstrap:main'
28+
'alzkb-build=alzkb.build.db:main'
29+
'alzkb-install=alzkb.build.install:main'
2830
]
2931
}
3032
)

0 commit comments

Comments
 (0)