About

Introduction

The Western Australian Centre for Road Safety Research (WACRSR) is initiating a project to automate the manual process of scanning and analyzing road safety literature. Currently, this process is labor-intensive, taking up valuable time that could be better spent on critical research tasks. To address this, the project aims to develop a system that leverages advanced large language models (LLMs) to streamline literature scanning and evaluation.

Group Members

Project Structure

./
├── api/
│   ├── app/
│   │   ├── controllers/
│   │   ├── models/
│   │   ├── services/
│   │   ├── utils/
│   │   └── __init__.py
│   ├── logs/
│   ├── migrations/
│   ├── config.py
│   ├── <env>.Dockerfile
│   ├── README.md
│   └── requirements.txt
├── secrets/
│   ├── els_api_key.txt
│   ├── els_token.txt
│   └── llm_api_key.txt
├── ui/
│   ├── app/
│   ├── public/
│   ├── .eslintrc.json
│   ├── .gitignore
│   ├── <env>.Dockerfile
│   ├── next-env.d.ts
│   ├── next.config.mjs
│   ├── package-lock.json
│   ├── package.json
│   ├── README.md
│   └── tsconfig.json
├── .gitignore
├── docker-compose.<env>.yml
└── README.md

Launch Papermate Application

0: Install Docker Desktop

Go to Docker website to download and install the application. Once Installed, make sure the docker engine is running.

1. Secrets

Contact developers to acquire the necessary three secret files: API key for Gemini, API key for Elsevier and Institutional token. After getting the files, create a folder named secrets/ under root folder:

├── secrets/
│   ├── els_api_key.txt
│   ├── els_token.txt
│   └── llm_api_key.txt

1.5. Create launch.json

If you would like to use vscode debugger function, add the following content to cofiguration file launch.json:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Remote Attach",
            "type": "debugpy",
            "request": "attach",
            "connect": {
                "host": "127.0.0.1",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}/api",
                    "remoteRoot": "/app"
                }
            ],
            "justMyCode": true
        }
    ]
}

2. Run docker-compose

Open the terminal that is under root foler, choose an environment e.g. docker-compose.debug.yml (which enables vscode debugger for api, without reloading):

docker compose up --build # With reloading enabled

or

docker compose -f docker-compose.debug.yml up --build # For using debugger

3. Access Papermate

Go to the url of Papermate http://localhost:3000/, the app should be up and running now.