From 30e327b745bf6eb4d6be0d9714d7a0c3c08529a2 Mon Sep 17 00:00:00 2001 From: Evan Morris Date: Fri, 8 Mar 2024 13:56:44 -0500 Subject: [PATCH] updating docs with more up to date default env vars, and note that NamedThing is required for nodes --- .env-template | 6 +++--- README.md | 11 ++++++----- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.env-template b/.env-template index 049c201..292a7bd 100644 --- a/.env-template +++ b/.env-template @@ -2,9 +2,9 @@ WEB_HOST=0.0.0.0 WEB_PORT=8080 NEO4J_HOST=localhost NEO4J_USERNAME=neo4j -NEO4J_QUERY_TIMEOUT=30 +NEO4J_QUERY_TIMEOUT=600 NEO4J_HTTP_PORT=7474 PLATER_SERVICE_ADDRESS=localhost PLATER_TITLE=Plater -PLATER_VERSION=1.3.0-12 -BL_VERSION=3.1.0 +PLATER_VERSION=1.5.1 +BL_VERSION=4.1.6 diff --git a/README.md b/README.md index 661077c..6a56b6d 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Another tool that comes in handy with Plater is [Automat](https://github.com/REN Nodes are expected to have the following core structure: 1. id : as neo4j node property with label `id` -2. category : Array of biolink types as neo4j node labels +2. category : Array of biolink types as neo4j node labels, it is required for every node to have at least the node label "biolink:NamedThing". 3. Additional attributes can be added and will be exposed. (more details on "Matching a TRAPI query" section) ##### Edges @@ -43,9 +43,9 @@ It's recommended that when encoding nodes labels in neo4j that we use the biolin "biolink:Entity", "biolink:PhysicalEssenceOrOccurrent"]` . -By doing such encoding, during lookup the incoming query is can be more laxed (ask for `biolink:NamedThing`) or more specific (ask for `biolink:SmallMolecule ` etc...), and PLATER would be able to use the encoded label information to find matching node(s). +By doing such encoding, during lookup the incoming query is can be more laxed (ask for `biolink:NamedThing`) or more specific (ask for `biolink:SmallMolecule ` etc...), and PLATER would be able to use the encoded label information to find matching node(s). -Similarly for edges, edge labels in neo4j are used to perform edge lookup. Predicate hierarchy in biolink would be consulted to find subclasses of the query predicate type(s) and those would be used in an `OR` combinatorial fashion to find results. +Similarly, for edges, edge labels in neo4j are used to perform edge lookup. Predicate hierarchy in biolink would be consulted to find subclasses of the query predicate type(s) and those would be used in an `OR` combinatorial fashion to find results. @@ -147,9 +147,10 @@ To run the web server directly: NEO4J_USERNAME=neo4j NEO4J_PASSWORD= NEO4J_HTTP_PORT=7474 + NEO4J_QUERY_TIMEOUT=600 PLATER_TITLE='Plater' - PLATER_VERSION='1.2.0-7' - BL_VERSION='1.6.1' + PLATER_VERSION='1.5.1' + BL_VERSION='4.1.6' ```