Demonstration Notebooks

Purpose:

The dashboard stats is a standalone library the demos are a set of notebooks which demonstrate the high level python required to run the dashboard stats library. This can be used as a starting point for non technical users. It is also good for running and prototyping output.

Getting Started

Database access

A direct connection to the ukrdc database is required. This can be achieved by following the instructions here:

https://renalregistry.atlassian.net/wiki/x/AQBUuQ?atlOrigin=eyJpIjoiZDE3ZDgyYTEzOThmNGM0ZWIzNTg3Y2E0ZDUxOGI0MmEiLCJwIjoiYyJ9

Downloading the repository

The library is hosted on the registry github here:

GitHub - renalreg/dashboard-stats: Library to run extracts on the ukrdc database for primarily for producing visualisations

If you don’t know how to clone with git this can be downloaded as a zip:

Open

Installing dashboard stats

You will need python installed. This can be done by submitting a helpdesk request.

1. Right click on folder which contains the repository and select the option “open in terminal

2. Create a virtual environment called .venv by coping and pasting the following command and hitting enter:

In the project folder there will now be a directory called .venv this contains all the packages which you install to enable the scripts/notebooks to run.

3. Install the poetry using the following command:

4. Use poetry to install everything else.

Running notebooks

1. Right click on folder which contains the repository and select the option “open in terminal

2. Start the notebook by running the following command

which should land you somewhere like this:

Open

Open

Note that you will need to be on the vpn to connect to the database.

For more info on how to use a notebook go here:

How to Use Jupyter Notebooks: The Ultimate Guide