summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrautenberg <rautenberg@in-silico.ch>2016-10-20 10:38:15 +0200
committerrautenberg <rautenberg@in-silico.ch>2016-10-20 10:38:15 +0200
commitfacc1bd43b5af7cb0635ecaef2f28bf96a87ae25 (patch)
treef3eee32a62cac5073392d864e952fd9b0d3694e2
parentb15945655f10af28d64dc41a255f3dc720efb48b (diff)
edit README
-rw-r--r--README.md44
-rw-r--r--api/api.json2
2 files changed, 44 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2aa04b6..9922d18 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,45 @@
# lazar-rest
-REST interface to lazar
+REST API webservice for lazar and nano-lazar.
+lazar (lazy structure–activity relationships) is a modular framework for read across predictions of chemical toxicities. Within the European Union’s FP7 eNanoMapper project lazar was extended with capabilities to handle nanomaterial data, interfaces to other eNanoMapper services (databases and ontologies) and a stable and user-friendly graphical interface for nanoparticle read-across predictions. **lazar-rest** provides a new Restful webservice to this developments.
+
+## Installation
+
+Download the code from github.
+
+```
+git clone https://github.com/opentox/lazar-rest.git
+```
+Install the required library gems with bundler
+```
+cd lazar-gem
+bundle install
+```
+
+In development environment use lazar and qsar-report library from source
+
+```ruby
+ require "../lazar/lib/lazar.rb"
+ require "../qsar-report/lib/qsar-report.rb"
+```
+
+In production environment change this to the following to have lazar and qsar-report library from ruby gem
+
+```ruby
+ require "../lazar/lib/lazar.rb"
+ require "../qsar-report/lib/qsar-report.rb"
+```
+
+start the service with unicorn on an assigned port
+```
+unicorn -p 8080 -D
+```
+(satrt without daemonize option *-D* for debugging)
+
+## Documentation
+
+For full Swagger API documentation open /api/api.json with Swagger UI.
+
+## Copyright
+
+Copyright (c) 2015-2016 Christoph Helma, Micha Rautenberg, Denis Gebele. See LICENSE for details. \ No newline at end of file
diff --git a/api/api.json b/api/api.json
index 0a323de..0fb0f8a 100644
--- a/api/api.json
+++ b/api/api.json
@@ -1,7 +1,7 @@
{
"swagger": "2.0",
"info": {
- "description": "REST API webservice for lazar and nano-lazar. \n*lazar* (lazy structure–activity relationships) is a modular framework for predictive toxicology. With activeted Authentication & Authorization, subjectid authorization token are obligatory for designated services.\n",
+ "description": "REST API webservice for lazar and nano-lazar. \n*lazar* (lazy structure–activity relationships) is a modular framework for predictive toxicology. With activated Authentication & Authorization, subjectid authorization token are obligatory for designated services.\n",
"version": "0.0.3",
"title": "Lazar & Nano-Lazar REST Service",
"contact": {