Qresp

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

docker run -e KEY=<SECRET_KEY> -p 8080:8080  qrespcontainer/qresp:latest

The -e KEY is an optional parameter used to set the passcode for the aministrator to manage the /admin page of Qresp.

More options can be provided:

docker run -e KEY=<SECRET_KEY> -e GOOGLE_CLIENT_ID=<GOOGLE_CLIENT_ID> -e GOOGLE_CLIENT_SECRET=<GOOGLE_CLIENT_SECRET> -e REDIRECT_URI=<REDIRECT_URI> -p 8080:8080  qrespcontainer/qresp:latest

The -p flag can be optionally provided to map the container port to the host port.

The -e GOOGLE_CLIENT_ID , -e GOOGLE_CLIENT_SECRET, and -e REDIRECT_URI are optional environment variables that enable Google oauth for publishing metadata with Qresp.

git clone https://github.com/qresp-code-development/qresp.git
cd qresp
docker-compose build
docker-compose up -d
  • Please make sure you edit all the environment variables in docker-compose.yml and docker-compose.override.yml. The nginx server is optional.

Note

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

Installation using Pip/Python

  • Use pip
pip install qresp
qresp
pip install qresp-pip-v1.0.tar.gz
qresp
  • Alternatively, one can clone the Qresp source from the Qresp GitHub repository and install Qresp using the python distutils:
git clone https://github.com/qresp-code-development/qresp.git
cd qresp/web
python setup.py install

Note

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

Warning

To publish your metadata generated by Qresp a MongoDB is required. The MongoDB can be configured by the admin, as explained in Paper exploration.