aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMunyoki Kilyungi2024-09-20 17:39:33 +0300
committerBonfaceKilz2024-09-23 12:32:51 +0300
commit509c8d0bf8b4c36d3efcb9d70d401baa740911b0 (patch)
tree03c0fbc97d69660579acf9240d3e77190389ac2f
parentff5da753e00bb0bdb5f5adf6fbe0ef52bfb3cc46 (diff)
downloadgenenetwork3-509c8d0bf8b4c36d3efcb9d70d401baa740911b0.tar.gz
Add section on setting up virtuoso locally.
Signed-off-by: Munyoki Kilyungi <me@bonfacemunyoki.com>
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 64cfdb0..02952a5 100644
--- a/README.md
+++ b/README.md
@@ -144,6 +144,16 @@ FAHAMU_AUTH_TOKEN="XXXXXX"
Note: The sparql configurations are important for running tests I.e. `pytest -k rdf`.
+### Setting up Virtuoso for Local Development
+
+GN3 uses Virtuoso to:
+
+- Fetch metadata for the Xapian indexing script
+- Fetch metadata for some end-points
+- Test SPARQL queries for some unit tests
+
+Local development setup instructions can be found [here](https://issues.genenetwork.org/topics/engineering/working-with-virtuoso-locally), while a more comprehensive tutorial is available [here](https://issues.genenetwork.org/topics/systems/virtuoso).
+
## Command-Line Utility Scripts
This project has a number of utility scripts that are needed in specific cirscumstances, and whose purpose is to support the operation of this application in one way or another. Have a look at the [Scripts.md file](./docs/Scripts.md] to see the details for each of the scripts that are available.