Peer-reviews-NLP: Set-Up

Overview

The purpose of this page is to describe the steps necessary to set up and run the peer-reviews-NLP web service, as well as what is actually happening during those steps (should they need to change). This page will assume a reader who is familiar with Python programming, but not with any particular technical tool used for application or web service hosting (such as Docker, etc.)

To read more about the peer-review-NLP project, see the main page on the project here.

Two separate scenarios will be explained

Step-by-Step Installation

Two alternatives will be outlined for installation of the peer-review-NLP web service. The first will assume you are installing the web service onto a deployed Ubuntu environment, for the purposes of deploying the project for use on the Expertiza website. The second will assume you wish to run the webservice on your local machine for the sake of testing and development.

Alternative 1: Installation on Deployed Ubuntu

1. Clone the public Github for the project to the machine you are deploying to. A link to the Github can be found here.
2. Install Docker and Docker Compose onto the machine by running the following code:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
apt-cache policy docker-ce
sudo apt-get install -y docker-ce
sudo systemctl status docker
sudo curl -L https://github.com/docker/compose/releases/download/1.26.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Note: if the given code did not successfully install Docker, refer to the following official documentation for proper download instructions.

1. Check to make sure docker has been properly installed by using the command

   docker-compose --version

2. Navigate to the directory "~/Peer-reviews-NLP" and run "sudo docker-compose up" to start the web service
3. If the web service goes down and needs to be rebuilt, utilize the command "sudo docker-compose up --build"