User Guide
This guide is for people who need to use RePORT AI Portal. It explains what the portal does, how it helps a study team, how to set it up, and how to run one study safely. It does not explain how the code is built.
Start Here
Reader |
Goal |
Start with |
|---|---|---|
Clinical researcher |
Ask questions about a locked, PHI-scrubbed study. |
|
Data manager |
Prepare raw study files and publish a safe bundle. |
|
Site operator |
Install, configure, and launch the portal locally. |
|
PI |
Understand the user workflow and where output evidence lives. |
Overview, then Data Pipeline |
What’s Included
Overview - what the portal is, who it helps, and when to use it.
Installation - system requirements and setup.
Quick Start - first run from raw study files to chat.
Configuration - the small set of settings most users touch.
Data Pipeline - a plain-language view of what happens when you load a study.
Glossary - user-facing terms.
Frequently Asked Questions - common setup, privacy, and troubleshooting questions.
Contents
Getting Started
Using the Portal
- Configuration
- Data Pipeline
- Glossary
- Frequently Asked Questions
- What is RePORT AI Portal?
- Who is it for?
- What can I ask it?
- What files do I need?
- Do I need an API key?
- How do I install it?
- How do I run it?
- Can I use an existing processed study?
- Does the assistant read raw files?
- What if my PDFs may contain PHI?
- Can I skip PDFs?
- Where do I check what happened during a run?
- What if I find raw PHI in output?
- Can it handle large datasets?
- Is there a GUI?
- Where are developer details?
Where Details Live
User pages stay brief on purpose. They should help a study team operate the portal without needing to understand how the code is built.
Other audience-specific detail stays in:
Developer Guide - architecture, source layout, tests, operational runbooks, and contributor guidance.
IRB/Auditor Profile - reviewer-facing PHI handling and conformance material.