Skip to content

PeterWayne12/md-dashboard-prototype

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

# MD Simulation Dashboard (Prototype)

A minimal real-time dashboard prototype for monitoring molecular dynamics (MD) simulations.

This project demonstrates a simple streaming architecture where:

- A FastAPI backend simulates a live frame stream

- A frontend dashboard polls the backend

- A live graph updates in real time to visualize frame progression


## 📂 Project Structure

backend/

app.py

stream.py

requirements.txt

frontend/

index.html

.gitignore

README.md


## 🚀 Features

- Real-time frame counter

- Backend simulation stream (fake streaming generator)

- Live updating graph using Chart.js

- Clean backend/frontend separation

- Ready for extension to IMDv3 + MDAnalysis integration


## 🛠 Tech Stack

- Python

- FastAPI

- Uvicorn

- HTML

- JavaScript

- Chart.js


## ▶️ How to Run

### 1️⃣ Clone the repository

git clone https://github.com/YOUR\_USERNAME/md-dashboard-prototype.git

cd md-dashboard-prototype


### 2️⃣ Create virtual environment

pip install -r backend/requirements.txt

If you don’t have requirements.txt, create it inside backend/ with:

fastapi

uvicorn

Server runs at:

http://127.0.0.1:8000


### 5️⃣ Open frontend

Open:

frontend/index.html

in your browser.

The dashboard will automatically poll the backend and display:

- Connection status

- Frame number

- Live updating graph of frame progression


## 📈 How It Works

- stream.py simulates a live frame generator.

- app.py exposes a /status API endpoint.

- The frontend uses fetch() with setInterval() to poll the backend.

- Chart.js updates the graph dynamically as frames increase.


## 🔮 Future Improvements

- Replace polling with WebSockets

- Integrate real IMDv3 streaming

- Add MDAnalysis real-time observables

- Add event detection & warnings

- Add real-time 3D visualization

- Improve UI styling


## 📜 License

MIT License


### 👨‍💻 Author

Built as a prototype for exploring real-time MD simulation monitoring architectures.

About

Real-time MD simulation dashboard prototype using FastAPI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors