Installation

A guide to installing SageRx locally.

Install locally

GitHub repo

sagerx

coderxio ⋅ 8 months ago

Prerequisites

• Install Docker.
• Windows users will also install WSL 2 (a Linux subsystem that runs on Windows) as part of this process.

Installation

1. Clone the repo.

git clone https://github.com/coderxio/sagerx.git

2. Add a .env file at the root of the repo (the /sagerx directory).
1. Windows users - use wsl terminal to do this step or find the /sagerx folder in File Explorer, right click within the open folder, click New → Text Document, and save it as .env with a file type of “All Files”, not “Text”.

cd sagerx
touch .env

3. Add ENV vars to the .env file.
1. Windows users - open your .env file in Notepad and add this text.

AIRFLOW_UID=<uid>
UMLS_API=<umls_api_key>

• AIRFLOW_UID=<uid> - replace <uid> with your own UID. UID can be found by running id -u on Linux systems, typically the first user on the system is 1000 or 1001.
• Windows users following the Docker Desktop install guide should have WSL 2 installed. You can open up command line, type wsl and then within WSL 2, you can enter id -u to see your UID.
• UMLS_API=<umls_api_key> - (optional) if you want to use RxNorm, you need an API key from UMLS. Replace <umls_api_key> with your own API key.

4. From within the /sagerx directory, run docker-compose up airflow-init and wait until exit code 0.
1. Windows users using Docker Desktop - run this and the following command in your Windows command prompt. Find the /sagerx folder in File Explorer, right click the /sagerx file folder, and click Open in Terminal.

docker-compose up airflow-init

5. Run docker-compose up.

docker-compose up

On this page

• Installation
• Install locally
• GitHub repo
• Prerequisites
• Installation