sirensolutions/chem_search_vis

Name: chem_search_vis

Owner: Siren

Description: null

Created: 2018-01-08 17:10:23.0

Updated: 2018-02-19 14:54:28.0

Pushed: 2018-02-26 13:56:04.0

Homepage: null

Size: 71

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Chemical Search plugin for Siren Federate

This repository contains the chemical search plugin for Siren Federate. It includes the visualisation plugin for molecular searches in Siren. These searches, based on chemical fingerprint similarities, requires a service to calculate these fingerprints on the fly. Siren provides a public site available for calculating these fingerprints for demo purposes at https://api.chemicalfingerprint.siren.io. This demo is provided as a courtesy on a best effort basis. For production deployments you should run your service internally and use it in the plugin. Find below how.

INSTALLATION

In order to use this widget you need to make it available to Siren Federate.

bin/investigate-plugin install 'https://github.com/sirensolutions/chem_search_vis/releases/download/v2.0/v2.0.zip'

Alternatively you can install using the provided script in this distribution. These steps assume that you have cloned kibi-internal and is at the same level as this repository::

one this repository if you haven't done so yet
t clone https://github.com/sirensolutions/chem_search_vis

is repository should be cloned at the same level as kibi-internal:
 kibi-internal

 into this repo and install the plugin:
 chem_search_vis
m install
de_modules/.bin/gulp sync

 this point the plugin should have been copied in the kibi-internal plugins' repo:
 ../kibi-internal/
Optional: Deploy a fingerprint API:

Siren provides a public site available for calculating molecular fingerprints at https://api.chemicalfingerprint.siren.io. The code to create this API is included in this repository under the fingerprint_api folder. If you prefer to deploy your own version of the API follow these instructions (Docker required)

ingerprint_api
er build -t fp_api:latest .
er run --name ls-api -p 8009:8080  -e PORT=8080 --rm fp_api
Optional: Change the source of the chemical structures in your deploy

If you have deployed your own fingerprint API you may want to use it to create the molecular representations displayed in Siren Investigate. By default the molecules are displayed using calls to the depict method of the default Siren deploy at https://api.chemicalfingerprint.siren.io. If you want to use your own deployed version of the API change the base URL directly in the UI: Go to Management => Indexes and Relations => chembl-molecules => fields. Search for the canonical-smiles field and edit the value of the URL template that is used to retrieve these molecular structures.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.