CM API

How to Set Up, Run the Backend API and Run the Interface

Requirements

• Operating System: macOS or Linux
• Python: Version 3.9 or higher
• CMake: Version 3.2.0 or higher
• GCC: Any version (used version in analysis: 9.2.0)
• R: With the following packages:
  • data.table
  • feather

Setup Instructions

1. Create and Activate a Virtual Environment in the main Directory

   Ensure that your terminal is in dashboard-cm directory

   Create a virtual enviroment:

   python -m venv env 

   OR

   python3 -m venv env 

   Activate the enviroment:

   source env/bin/activate 

2. Initialize and Update Submodule

   The repository includes a submodule cm_pipeline that needs initialization.

   Ensure your terminal is in the cm_pipeline directory:

   cd cm_pipeline

   Initialize the submodule:

   git submodule init

   Update the submodule:

   git submodule update

3. Install cm_pipeline Requirements

   Navigate to the cm_pipeline directory:

   Install the requiremnts

   pip install -r requirements.txt

4. Install API Requirements

   Navigate to the api directory:

   Install the requiremnts

   pip install -r requirements.txt

5. Run the Backend Server Locally

   Within the api directory, start the backend server:

   uvicorn main:app --reload

Now your environment is set up and the backend server should be running locally.

3. Run the Interface Server Locally

   Navigate to the interface_protoype directory

   Install the requiremnts

   pip install -r requirements.txt

   streamlit run home.py

Now the interface server should be running locally.