Skip to content

Commit baa89fa

Browse files
authored
Update README.md
Added installation instructions, including additional steps for `SqlImplementation`
1 parent 5b07357 commit baa89fa

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,18 @@ OAK uses [`pystow`](https://github.com/cthoyt/pystow) for caching. By default,
223223
this goes inside `~/.data/`, but can be configured following
224224
[these instructions](https://github.com/cthoyt/pystow#%EF%B8%8F%EF%B8%8F-configuration).
225225

226+
## Installation
227+
### General purpose installation
228+
1. Python 3.9+
229+
2. Run: `pip install oaklib`
230+
231+
### SqlImplementation requirements
232+
If using `SqlImplementation`, some additional steps beyond _general purpose installation_ are required.
233+
1. Install [`sqlite`](https://www.sqlite.org/download.html)
234+
2. Install [`relation-graph`](https://github.com/balhoff/relation-graph#installation)
235+
4. Install [`rdftab`](https://github.com/ontodev/rdftab.rs#installation)
236+
3. Install `riot`. Can install via [HomeBrew](https://brew.sh/) on MacOS via: `brew install jena`
237+
226238
## Developer notes
227239

228240
### Local project setup

0 commit comments

Comments
 (0)