Validation App Installation

This guide provides a walkthrough for the installation process involved with the renal registry’s /wiki/spaces/RR/pages/1295318883.

Before you being

This guide assumes you have correctly configured your **environment**, that you have installed **virtualenv** and **pip**, and that you have followed the instruction for installing the DevPi client

It also assumes that you have correctly cloned, tagged and branched the required code according to the Creating validation (and other) build and releases

Installation Walkthrough


  • Navigate to the code

Using a shell navigate to the folder that contains the code you cloned from bit bucket during the Creating validation (and other) build and releases process. These paths are in line with those found in the guide and should be adjusted to match your local paths if necessary.


CMD
cd u:

cd "my Documents\projects\renal_registry"
BASH
cd u:

cd my\ documents/projects/renal_registry/


  • Virtual Envirmonet

The virtual environment can be installed in any folder but storing your virtual environments in the same location as the code that you intend to run is a good idea. In this case the aim is to launch validation so the virtual environment will be created inside rr_valdiation.

Navigate to the desired location for the virtual environment (rr_validation) then create the virtual environment using the following commands. In the below example “venv” can be substituted with anything that makes sense to you.


CMD
cd rr_validation
c:\Python27\Scripts\virtualenv venv
BASH
cd rr_validation
/c/Python27/Scripts/virtualenv venv


  • Activate the Environment

To enter the virtual environment use the following shell commands insuring that you substitute your environment name for venv where appropriate.

If the activation was successful you should see that your virtual environment name, surrounded by parenthesis, now prefixes you current shell path location (CMD) or is just above it (BASH).


CMD
venv\Scripts\activate
BASH
source venv/Scripts/activate


  • Install the Required Packages

rr_validation has a requirements file that lists all of the packages that are required to run the application. Running the following command from inside your virtual environment will retrieve and install these packages for you.


CMD and BASH
pip install -r requirments.txt

Warning: This will take some time. Grab a coffee.


  • Run the Validation App

The installation is complete and the app is now ready to run. The following command will launch the application


CMD and BASH
python scripts/val.py

Warning: The app is very slow to start.


Once the app has had sufficient time to load you should be presented with the following window

Please see the /wiki/spaces/RR/pages/1295318883 for further information on using the validation tool.