Skip to content

Commit

Permalink
updating docs with more up to date default env vars, and note that Na…
Browse files Browse the repository at this point in the history
…medThing is required for nodes
  • Loading branch information
EvanDietzMorris committed Mar 8, 2024
1 parent 1313901 commit 30e327b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions .env-template
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.



Expand Down Expand Up @@ -147,9 +147,10 @@ To run the web server directly:
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=<change_me>
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'
```

Expand Down

0 comments on commit 30e327b

Please sign in to comment.