Skip to content

Qresp Installation

Qresp is a software with a GUI which guides the user in creating metadata from the data associated to a scientific paper (step 1). It can then be used to search curated papers, view charts, notebooks, workflows on a per publication basis and download the data associated to a scientific paper. The metadata gathered during this curation step includes data location, publication details and user-defined attributes. The metadata is generated using the JSON (JavaScript Object Notation) syntax and the metadata file is sent to a document-oriented database. The current implementation uses MongoDB which is an open source software.

Installation using Docker

Clone the Qresp source from Qresp GitHub Repository and use Docker Compose

git clone https://github.com/qresp-code-development/qresp.git
cd qresp
git checkout master
docker-compose up -d --build

Please make sure you edit all the variables in config.ini to utilize all the capabilities of qresp. If not, you'll still be able to use the explorer section but the curator sections wouldn't work as intended.

See the list of required variables below (with examples).

[GLOBAL]
MAIL_ADDR = x@y.com
SMTP_SERVER = smtp.gmail.com
SMTP_PORT = 587

[PROD]
MONGODB_HOST = db.y.com
MONGODB_PORT = 27017
MONGODB_USERNAME = username
MONGODB_PASSWORD = password
MONGODB_DB_NAME = index_name

[SECRETS]
MAIL_PWD = Password for the MAIL_ADDR (specified above) in the SMTP server

Warning

If you don't have the correct ssl certificates, you'll need to remove (or comment) out few lines othwerwise you'll run into build issues. Specifically:

Delete the above mentioned lines or add a # at the start of each line

We recommend, setting up the MongoDb instance out of the docker services, but you can use docker-compose.yml.services to run both mongodb and nginx containers.

Once the installation is completed, please use your browser to access the Qresp portal using the port number used in docker run. For e.g., http://localhost:8080

Note

Once the installation is completed, please use your browser to access the Qresp portal using the address reported in the output.