Improve layout for adding sources
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
# Gallery: Scientific Plot Gallery Generator
|
||||
# Gallery: Scientific Plot Organizer
|
||||
|
||||
[](https://www.python.org/downloads/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
A professional, production-ready Python package for creating responsive HTML galleries from scientific plot collections. Convert PDFs to PNG, organize plots hierarchically, and generate beautiful static websites.
|
||||
**Create responsive HTML galleries for scientific plot collections. Convert PDFs to PNG, organize plots hierarchically, and generate beautiful static websites.**
|
||||
|
||||
## ✨ Features
|
||||
## Features
|
||||
|
||||
### Core Functionality
|
||||
- **PDF to PNG Conversion**: Automatic high-quality thumbnail generation using ImageMagick
|
||||
@@ -16,47 +16,17 @@ A professional, production-ready Python package for creating responsive HTML gal
|
||||
|
||||
### Advanced Features
|
||||
- **Plot Comparison**: Side-by-side comparison tool for analyzing differences
|
||||
- **Metadata Management**: YAML/JSON metadata with inheritance and display
|
||||
- **Export Capabilities**: Batch export selected plots
|
||||
- **Metadata Management**: YAML/JSON metadata with inheritance and display, to properly label each folder
|
||||
- **Recent Plots**: Quick access to recently viewed items
|
||||
- **Theme Support**: Dark/light theme toggle
|
||||
- **Keyboard Shortcuts**: Power-user navigation
|
||||
|
||||
### Developer-Friendly
|
||||
- **Python API**: Import and use programmatically in other projects
|
||||
- **CLI Interface**: Command-line tool for git-clone based deployments
|
||||
- **Configuration Flexibility**: YAML config file or pure Python objects
|
||||
- **Error Handling**: Returns False instead of raising, with optional verbose output
|
||||
- **CLI Interface**: Command-line command `gallery`
|
||||
- **TUI Interface**: Textual-based terminal UI `gallery tui`
|
||||
- **Configuration Flexibility**: Config file stored under user `$HOME/.config/gallery`
|
||||
- **Source Override**: Process single directories without full regeneration
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd scientific-gallery-generator
|
||||
```
|
||||
|
||||
2. **Configure sources**
|
||||
```bash
|
||||
config.yaml # Edit config.yaml to point to your plot directories
|
||||
```
|
||||
|
||||
3. **Generate gallery**
|
||||
|
||||
* 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
|
||||
|
||||
@@ -102,7 +72,9 @@ paths:
|
||||
|
||||
### Metadata Files
|
||||
|
||||
Create `metadata.yaml` files in your source directories:
|
||||
Create `metadata.yaml` files in your source directories. The fields are all arbitrary and rendered using
|
||||
yaml object interpretation (dict, list...). You can have different metadata.yaml files in each folder,
|
||||
with lower-level fields overriding the parent values. Great for labelling specific experiments.
|
||||
|
||||
```yaml
|
||||
# metadata.yaml
|
||||
|
||||
Reference in New Issue
Block a user