[WIP] Add tests and coverage

This commit is contained in:
Kylian Schmidt
2025-09-08 10:52:58 +02:00
parent be99b3e601
commit 657b273975
21 changed files with 7919 additions and 158 deletions
+30 -17
View File
@@ -6,6 +6,7 @@
A powerful, responsive web-based gallery generator for scientific plots and analysis results. Transform your PDF plots into interactive HTML galleries with search, comparison tools, and hierarchical metadata management.
## ✨ Features
### 🎯 Core Functionality
@@ -30,23 +31,10 @@ A powerful, responsive web-based gallery generator for scientific plots and anal
- **LaTeX Support**: Mathematical expressions rendered with MathJax
- **Path Information**: Easy access to metadata file locations
## 📸 Screenshots
### Main Gallery View
![gallery_view](docs/images/main_gallery_view.png)
### Metadata Display
![metadata](docs/images/metadata_view.png)
### Plot Comparison Tool
![plot_comparison](docs/images/plot_comparison.png)
### Search Functionality
<img src="docs/images/search.png" width="500px">
## 🚀 Quick Start
### Prerequisites
### Prerequisites (when running barebones)
```bash
# Required system dependencies
@@ -70,15 +58,40 @@ pip install jinja2 pyyaml
```
3. **Generate gallery**
```bash
python generate_gallery.py
```
* Barebones (after installing dependencies yourself)
```bash
python generate_gallery.py
```
* Apptainer / Singularity
```bash
apptainer run -B /web,/work,/ceph gallery.sif
```
4. **Serve locally** (optional)
```bash
python -m http.server 8000 -d /path/to/web/directory
```
## 📸 Screenshots
### Main Gallery View
![gallery_view](docs/images/main_gallery_view.png)
### Metadata Display
![metadata](docs/images/metadata_view.png)
### Plot Comparison Tool
![plot_comparison](docs/images/plot_comparison.png)
### Search Functionality
<img src="docs/images/search.png" width="500px">
## ⚙️ Configuration
### config.yaml Structure