Skip to content

Commit e2c3adc

Browse files
committed
docs update
1 parent 19e40d8 commit e2c3adc

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

docker-compose.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,16 @@ services:
2626

2727
# This container runs the REST API that queries the test database.
2828
# Some useful queries are:
29-
# export FRAGNET_SERVER=http://localhost
29+
# export FRAGNET_SERVER="http://localhost:8080"
3030
# curl $FRAGNET_SERVER:8080/fragnet-search/rest/ping
3131
# curl $FRAGNET_SERVER:8080/fragnet-search/rest/v2/search/suppliers
3232
# curl "$FRAGNET_SERVER:8080/fragnet-search/rest/v2/search/molecule/OC(Cn1ccnn1)C1CC1"
3333
# curl "$FRAGNET_SERVER:8080/fragnet-search/rest/v2/search/neighbourhood/OC(Cn1ccnn1)C1CC1?hac=3&rac=1&hops=2"
3434
# curl "$FRAGNET_SERVER:8080/fragnet-search/rest/v2/search/availability/OC(Cn1ccnn1)C1CC1"
3535
# curl "$FRAGNET_SERVER:8080/fragnet-search/rest/v2/search/expand/OC(Cn1ccnn1)C1CC1?hacMin=5&hacMax=10&racMin=3&racMax=3&hops=2"
3636
# curl --data-binary "@fragnet-search/src/test/data/expand.smi" -H "Content-Type: chemical/x-daylight-smiles" "$FRAGNET_SERVER:8080/fragnet-search/rest/v2/search/expand-multi?hacMin=5&hacMax=5&racMin=2&racMax=2&hops=2"
37+
# curl "$FRAGNET_SERVER/fragnet-search/rest/v2/search/fragments/OC(Cn1ccnn1)C1CC1"
38+
# curl "$FRAGNET_SERVER/fragnet-search/rest/v2/search/synthon-expand/OC(Cn1ccnn1)C1CC1?synthon=%5BXe%5Dn1ccnn1&hops=2&hacMin=14&hacMax=18"
3739
fragnet-search:
3840
image: squonk/fragnet-search:latest
3941
environment:

fragnet-search/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ restricted to specific suppliers.
3030
4. Availability search - find the forms of a molecule from the fragment network that are available from suppliers
3131
5. Expansion search - expand out a single molecule returning isomeric molecules that can be purchased
3232
6. Expansion multi search - expand out a set of molecules returning isomeric molecules that can be purchased
33+
7. Fragments search - fetch all child fragments of a molecule
34+
8. Synthon expansion search - find expansions of a molecule that contain a particular "synthon"
3335

3436

3537
### Supplier search
@@ -46,7 +48,10 @@ of a comma separated list of supplier names. These must be specified __exactly__
4648
### Molecule search
4749

4850
This allows you to find out if the specified molecule is part of the fragment network.
49-
This is available from the `fragnet-search/rest/v2/search/molecule/{smiles}` endpoint.
51+
This is available from the `fragnet-search/rest/v2/search/molecule/{smiles}` endpoint. For example:
52+
```
53+
curl "${FRAGNET_SERVER}/fragnet-search/rest/v2/search/molecule/OC(Cn1ccnn1)C1CC1"
54+
```
5055
If the molecule is not present you get a 404 response. If it is present you get back a 200 response containing JSON
5156
with basic information about the molecule, e.g.
5257
```
@@ -714,7 +719,7 @@ To achieve this you will need to:
714719
For instance, assuming have [curl] and [jq] installed, to perform step 3 you will need to do something like this:
715720

716721
```
717-
token=$(curl -d "grant_type=password" -d "client_id=fragnet-search" -d "username=<username>" -d "password=<password>"\
722+
token=$(curl -d "grant_type=password" -d "client_id=fragnet-search-ui" -d "username=<username>" -d "password=<password>"\
718723
https://squonk.it/auth/realms/squonk/protocol/openid-connect/token 2> /dev/null \
719724
| jq -r '.access_token')
720725
```

0 commit comments

Comments
 (0)