How mwasifanwar/neuroscan-ai works
Project type and purpose
• NeuroScan-AI is a standalone data-processing application with an interactive Streamlit front end. Its core is a set of image-processing “pipelines” (scan, OCR, enhance), plus utility modules for geometry, I/O, and PDF handling. It’s packaged as a Docker container for consistent deployment.
File structure
• Top level
• Dockerfile, requirements.txt – define the runtime environment
• README.md – project title (“NeuroScan-AI”)
• app/ – the back-end processing library
• web/ – the Streamlit UI script
• tests/ – unit tests for key modules
• app/
• main.py – orchestrates pipeline execution
• config.py – configuration loader
• schemas.py – data models or typing definitions
• pipelines/ – individual pipeline modules (scan.py, ocr.py, enhance.py)
• utils/ – shared low-level helpers (geometry, image I/O, PDF)
• web/
• streamlit_app.py – user interface entry point that imports and invokes app/ components
README for additional insights
• Although minimal, the name “NeuroScan-AI” suggests AI-driven image scanning and OCR. No external services or databases are mentioned, so it is self-contained.
Detail without overcomplicating
• Modules under their logical layer
• Config.py feeding parameters into the orchestrator
• Dockerfile at the top-level, pointing to the container boundary
• Do not omit the local filesystem/volume – it’s the only persistent store