https://github.com/andreped/wsi-visualization-demo

🔬 Simple containerised whole slide image rendering in the browser
https://github.com/andreped/wsi-visualization-demo

browser deepzoom docker dzi histopathology html http hugging-face hugging-face-spaces huggingface nginx openseadragon pathology real-time web whole-slide-image wsi

Last synced: about 2 months ago
JSON representation

🔬 Simple containerised whole slide image rendering in the browser

• Host: GitHub
• URL: https://github.com/andreped/wsi-visualization-demo
• Owner: andreped
• License: mit
• Created: 2024-10-17T13:15:15.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-18T04:31:57.000Z (2 months ago)
• Last Synced: 2024-10-20T19:38:33.763Z (2 months ago)
• Topics: browser, deepzoom, docker, dzi, histopathology, html, http, hugging-face, hugging-face-spaces, huggingface, nginx, openseadragon, pathology, real-time, web, whole-slide-image, wsi
• Language: HTML
• Homepage: https://huggingface.co/spaces/andreped/wsi-visualization-demo
• Size: 16.9 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
---

title: wsi-visualization-demo

emoji: 🔬

colorFrom: blue

colorTo: red

sdk: docker

sdk_version: "24.0.6"

app_file: Dockerfile

pinned: false

---

# wsi-visualization-demo

[![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/andreped/wsi-visualization-demo/blob/main/LICENSE.md)



## Why?

This repository was developed to demonstrate how to do the following:

* Creating a simple web application for rendering a whole slide image in real time.

* Containerizing and deploying a web app for deployment on Hugging Face Spaces.

To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app.



## Stack

For this demonstration, we have used the following:

| Component | Description |

| - | - |

| **OpenSeadragon** | The actual library for rendering the WSI |

| **Deep Zoom Image (DZI)** | Image file format compatible with OpenSeadragon |

| **nginx** | HTTP web server |

| **Docker** | Containerization of the web app |

| **Hugging Face Spaces** | Deployment platform |

## Continuous integration

For this project, we continuously update the Hugging Face deployment for each commit to the main branch.

| Build Type | Status |

| - | - |

| **HF Space Deploy** | [![CI](https://github.com/andreped/wsi-visualization-demo/workflows/Deploy/badge.svg)](https://github.com/andreped/wsi-visualization-demo/actions) |

| **File Size Check** | [![CI](https://github.com/andreped/wsi-visualization-demo/workflows/Check%20file%20size/badge.svg)](https://github.com/andreped/wsi-visualization-demo/actions) |

## Docker

1. Build image:

```

docker build -t wsi-visualization .

```

2. Run image:

```

docker run -p 7860:7860 wsi-visualization

```

3. Open in browser:

```

open http://localhost:7860

```

## License

This project has MIT License.