OptimaLab35/README.md

88 lines
3.1 KiB
Markdown
Raw Normal View History

2025-01-03 16:26:17 +00:00
# **OptimaLab35**
[OptimaLab35](https://gitlab.com/CodeByMrFinchum/OptimaLab35) is a graphical and terminal user interface for [optima35](https://gitlab.com/CodeByMrFinchum/optima35). It is under **heavy development**, and both UI elements and cross-platform compatibility may change.
2025-01-03 12:20:39 +01:00
2024-12-10 15:39:10 +01:00
2025-01-03 16:26:17 +00:00
## **Overview**
2024-12-10 15:39:10 +01:00
2025-01-03 16:26:17 +00:00
**OptimaLab35** extends **OPTIMA35** (**Organizing, Processing, Tweaking Images, and Modifying scanned Analogs from 35mm Film**) by providing an intuitive interface for image and metadata management. While tailored for analog photography, it supports any type of image.
2024-12-10 15:44:44 +01:00
2024-12-30 20:19:49 +00:00
2025-01-03 16:26:17 +00:00
## **Current Status**
### **Versioning and Compatibility**
The preserved version **v0.1.0** ensures stability with the current GUI design. It depends on **optima35==0.6.4**, a version confirmed to work seamlessly with this release. Future updates may introduce breaking changes, especially as the project evolves across platforms.
### **Installation**
Install via pip (dependencies are automatically managed, except for `simple-term-menu` used in TUI mode, which is Linux-only):
```bash
2025-01-03 12:20:39 +01:00
pip install OptimaLab35
```
2025-01-03 16:26:17 +00:00
## **Development and Notes**
2024-12-30 20:19:49 +00:00
2025-01-03 16:26:17 +00:00
**Alpha Stage**
- UI designs (GUI and TUI) are evolving, and breaking changes may occur.
- The [**CHANGELOG**](https://gitlab.com/CodeByMrFinchum/OptimaLab35/-/blob/main/CHANGELOG.md) provides detailed updates.
- Some safety checks are still under development.
2025-01-03 16:26:17 +00:00
**Modes:**
- **GUI**: Default if **PySide6** is available.
- **TUI**: Fallback if **PySide6** is missing or can be explicitly started using the `--tui` flag.
2024-12-30 20:19:49 +00:00
2025-01-03 16:26:17 +00:00
## **Features**
2024-12-27 20:55:20 +00:00
2025-01-03 16:26:17 +00:00
### **Image Processing**
2025-01-03 12:20:39 +01:00
- Resizing
2025-01-03 16:26:17 +00:00
- Renaming with custom order
2025-01-03 12:20:39 +01:00
- Grayscale conversion
2025-01-03 16:26:17 +00:00
- Brightness and contrast adjustment
2025-01-03 16:26:17 +00:00
### **EXIF Management**
- Copy or add custom EXIF data
- Add GPS coordinates
- Add or modify EXIF dates
- Remove EXIF metadata
2025-01-03 16:26:17 +00:00
### **Watermarking**
- Add customizable watermarks
2024-12-17 11:25:44 +00:00
2025-01-03 16:26:17 +00:00
## **Dependencies**
2024-12-17 11:25:44 +00:00
2025-01-03 16:26:17 +00:00
**GUI Mode:**
- `optima35`
- `pyside6`
2024-12-17 11:25:44 +00:00
2025-01-03 16:26:17 +00:00
**TUI Mode (Linux only):**
- `simple-term-menu`
2024-12-17 11:25:44 +00:00
2024-12-10 15:39:10 +01:00
# Use of LLMs
In the interest of transparency, I disclose that Generative AI (GAI) large language models (LLMs), including OpenAIs ChatGPT and Ollama models (e.g., OpenCoder and Qwen2.5-coder), have been used to assist in this project.
2024-12-10 15:39:10 +01:00
## Areas of Assistance:
- Project discussions and planning
- Spelling and grammar corrections
- Suggestions for suitable packages and libraries
- Guidance on code structure and organization
In cases where LLMs contribute directly to code or provide substantial optimizations, such contributions will be disclosed and documented in the relevant sections of the codebase.
2024-12-30 20:19:49 +00:00
**Ollama**
- mradermacher gguf Q4K-M Instruct version of infly/OpenCoder-1.5B
- unsloth gguf Q4K_M Instruct version of both Qwen/QWEN2 1.5B and 3B
2024-12-17 11:25:44 +00:00
### References
1. **Huang, Siming, et al.**
*OpenCoder: The Open Cookbook for Top-Tier Code Large Language Models.*
2024. [PDF](https://arxiv.org/pdf/2411.04905)
2. **Hui, Binyuan, et al.**
*Qwen2.5-Coder Technical Report.*
*arXiv preprint arXiv:2409.12186*, 2024. [arXiv](https://arxiv.org/abs/2409.12186)
3. **Yang, An, et al.**
*Qwen2 Technical Report.*
*arXiv preprint arXiv:2407.10671*, 2024. [arXiv](https://arxiv.org/abs/2407.10671)