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 --rm --name qresp -p 8080:80 qrespcontainers/qresp:latest

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

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 config.ini to utilize all the capabilities of qresp.

  • Optionally, use docker-compose.yml.services to run both mongodb and nginx containers.

Note

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

Installation using Pip/Python

  • Use pip

pip install qresp
qresp
pip install qresp-1.2.0.tar.gz
qresp 8080#port
  • 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
  • Please make sure you edit all the environment variables in config.ini to utilize all the capabilities of qresp.

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.