User and Developer Manual - uiowaSEP2024/002_ImagePro GitHub Wiki

Welcome to the ImageInsights User and Developer Manual

Purpose of This Manual

The ImageInsights system encompasses numerous components, presenting a substantial challenge, especially for those new to the fields of Medical Imaging and Healthcare development. This manual aims to accelerate the onboarding process for developers by introducing industry standards, design constraints, and regulatory compliance requirements. We also provide an depth guide for users to demonstrate how our application runs. In doing so, we hope to demystify the various components of our project, facilitating a deeper understanding for all team members and users current and future.

How to Use This Manual

To get the most out of this manual, we recommend the following approach:

  • Start with the Overview: Familiarize yourself with the high-level architecture and flow of data within the ImageInsights system. This will help you understand how various components interact.
  • Explore Diagrams and Flowcharts: Visual aids are integrated throughout the manual to help you visualize complex processes and system interactions.
  • Go in depth with a walkthrough of our application

Quick Links

  • Contribution Standards: Before contributing, please review our standards to ensure consistency and quality in our codebase.