clean up in anticipation of 9.0.2 release (#70)

- rename album.js to album-manager.js for consistency with .py and .css files
- change user message "starting umapping" to "starting mapping" to avoid jargon
- UPDATE REQUIREMENTS TO 3.10-3.13. 3.13 seems to work fine.
- update documentation

Co-authored-by: Lincoln Stein <lstein@gmail.com>

Author: lstein

INSTALL/lib/windows.ps1

@@ -77,7 +77,7 @@ $version = python -c "import sys; print(f'{sys.version_info.major}.{sys.version_
 if (-not $version) {
     Install-Python "Could not determine Python version."
 }
-if ([version]$version -lt [version]"3.10" -or [version]$version -ge [version]"3.13") {
+if ([version]$version -lt [version]"3.10" -or [version]$version -ge [version]"3.14") {
     Install-Python "An incompatible Python version is installed."
 }
 

README.md

@@ -27,7 +27,7 @@ PhotoMap's unique feature is its ability to identify thematically similar images
 
 In this map, each image in the photo collection is represented as a dot. The colors distinguish different clusters of related images. You can zoom in and out of the map and pan around it. Hover the mouse over a dot in order to see a preview thumbnail of its image, or click on a cluster to view its contents at full resolution.
 
-You can move the semantic map around, shrink it down in size, or hide it altogether. As you browser your photo collection, a yellow dot marker will highlight the location of the current image in the map.
+You can move the semantic map around, shrink it down in size, or hide it altogether. As you browse your photo collection, a yellow dot marker will highlight the location of the current image in the map.
 
 ## Text and Image Similarity Search
 
@@ -118,7 +118,7 @@ Follow these instructions if you are comfortable with installing Python packages
 
 #### Mac/Linux
 
-Make sure that your version of Python is between 3.10 and 3.12. Not all required libraries are available in 3.13.
+Make sure that your version of Python is between 3.10 and 3.13. Other versions are not guaranteed to work.
 
 python3 -m venv ~/photomap --prompt photomap
 source ~/photomap/bin/activate
@@ -130,7 +130,7 @@ Then open your web browser and point it to [http://127.0.0.1:8050](http://128.0.
 
 #### Windows
 
-Make sure that your version of Python is between 3.10 and 3.12. Not all required libraries are available in 3.13. Also make sure that Python is on your PATH.
+Make sure that your version of Python is between 3.10 and 3.13. Other versions are not guaranteed to work. Also make sure that Python is on your PATH.
 
 python3 -m venv C:\Users\<your name>\Documents\photomap --prompt photomap
 C:\Users\<your name>\Documents\photomap\Scripts\activate

docs/index.md

@@ -34,7 +34,7 @@ PhotoMapAI's unique feature is its ability to identify thematically similar imag
 
 In this map, each image in the photo collection is represented as a dot. The colors distinguish different clusters of related images. You can zoom in and out of the map and pan around it. Hover the mouse over a dot in order to see a preview thumbnail of its image, or click on a cluster to view its contents at full resolution.
 
-You can move the semantic map around, shrink it down in size, or hide it altogether. As you browser your photo collection, a yellow dot marker will highlight the location of the current image in the map.
+You can move the semantic map around, shrink it down in size, or hide it altogether. As you browse your photo collection, a yellow dot marker will highlight the location of the current image in the map.
 
 ## Text and Image Similarity Search
 

photomap/backend/embeddings.py

@@ -478,7 +478,7 @@ def traversal_callback(count, message):
             progress_tracker.set_error(album_key, str(e))
             raise
 
-        progress_tracker.start_operation(album_key, total_images, "umapping")
+        progress_tracker.start_operation(album_key, total_images, "mapping")
         try:
             umap_embeddings = await asyncio.to_thread(
                 self.create_umap_index, result.embeddings
@@ -669,7 +669,7 @@ def traversal_callback(count, message):
             self._save_embeddings(combined_result)
 
             # Rebuild the umap index
-            progress_tracker.start_operation(album_key, total_new_images, "umapping")
+            progress_tracker.start_operation(album_key, total_new_images, "mapping")
             new_result.umap_embeddings = await asyncio.to_thread(
                 lambda: self.umap_embeddings
             )

photomap/backend/progress.py

@@ -1,25 +1,28 @@
-'''
+"""
 Progress tracking module for indexing operations in Clipslide.
 This module provides a global progress tracker for indexing operations,
 allowing for tracking the status, progress, and estimated time remaining
-for each album being processed.'''
-from typing import Dict, Optional
+for each album being processed."""
+
+import logging
+import time
 from dataclasses import dataclass
 from enum import Enum
-import time
-import logging
+from typing import Dict, Optional
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
+
 class IndexStatus(Enum):
     IDLE = "idle"
     SCANNING = "scanning"
     INDEXING = "indexing"
-    UMAPPING = "umapping"
+    UMAPPING = "mapping"
     COMPLETED = "completed"
     ERROR = "error"
 
+
 @dataclass
 class ProgressInfo:
     album_key: str
@@ -29,17 +32,17 @@ class ProgressInfo:
     total_images: int
     start_time: float
     error_message: Optional[str] = None
-    
+
     @property
-    def progress_percentage(self)-> float:
+    def progress_percentage(self) -> float:
         if self.total_images == 0:
             return 0.0
         return (self.images_processed / self.total_images) * 100
-    
+
     @property
     def elapsed_time(self) -> float:
         return time.time() - self.start_time
-    
+
     @property
     def estimated_time_remaining(self) -> Optional[float]:
         if self.images_processed == 0:
@@ -48,12 +51,13 @@ def estimated_time_remaining(self) -> Optional[float]:
         remaining_images = self.total_images - self.images_processed
         return remaining_images / rate if rate > 0 else None
 
+
 class ProgressTracker:
     """Global progress tracker for indexing operations."""
-    
+
     def __init__(self):
         self._progress: Dict[str, ProgressInfo] = {}
-    
+
     def start_operation(self, album_key: str, total_images: int, operation_type: str):
         """Start tracking progress for an album."""
         self._progress[album_key] = ProgressInfo(
@@ -62,50 +66,62 @@ def start_operation(self, album_key: str, total_images: int, operation_type: str
             current_step=f"Starting {operation_type}",
             images_processed=0,
             total_images=total_images,
-            start_time=time.time()
+            start_time=time.time(),
         )
-    
+
     def update_total_images(self, album_key: str, total_images: int):
         """Update the total number of images for an operation."""
         if album_key in self._progress:
             self._progress[album_key].total_images = total_images
-    
-    def update_progress(self, album_key: str, images_processed: int, current_step: str = ""):
+
+    def update_progress(
+        self, album_key: str, images_processed: int, current_step: str = ""
+    ):
         """Update progress for an album."""
         if album_key in self._progress:
             progress = self._progress[album_key]
             progress.images_processed = images_processed
             progress.current_step = current_step
-            if images_processed >= progress.total_images and progress.status != IndexStatus.SCANNING:
+            if (
+                images_processed >= progress.total_images
+                and progress.status != IndexStatus.SCANNING
+            ):
                 progress.status = IndexStatus.COMPLETED
-    
+
     def set_error(self, album_key: str, error_message: str):
         """Set error status for an album."""
         if album_key in self._progress:
             progress = self._progress[album_key]
             progress.status = IndexStatus.ERROR
             progress.error_message = error_message
-    
+
     def get_progress(self, album_key: str) -> Optional[ProgressInfo]:
         """Get progress info for an album."""
         return self._progress.get(album_key)
-    
+
     def remove_progress(self, album_key: str):
         """Remove progress tracking for an album."""
         self._progress.pop(album_key, None)
-    
+
     def is_running(self, album_key: str) -> bool:
         """Check if an operation is currently running for an album."""
         progress = self._progress.get(album_key)
-        return progress is not None and progress.status in [IndexStatus.SCANNING, IndexStatus.INDEXING, IndexStatus.UMAPPING]
-    
-    def complete_operation(self, album_key: str, message: str = "Operation completed") -> None:
+        return progress is not None and progress.status in [
+            IndexStatus.SCANNING,
+            IndexStatus.INDEXING,
+            IndexStatus.UMAPPING,
+        ]
+
+    def complete_operation(
+        self, album_key: str, message: str = "Operation completed"
+    ) -> None:
         """Mark an operation as completed."""
         if album_key in self._progress:
             progress = self._progress[album_key]
             progress.status = IndexStatus.COMPLETED
             progress.current_step = message
             progress.images_processed = progress.total_images
 
+
 # Global instance
-progress_tracker = ProgressTracker()
+progress_tracker = ProgressTracker()

…omap/frontend/static/javascript/album.js …ntend/static/javascript/album-manager.jsphotomap/frontend/static/javascript/album.js renamed to photomap/frontend/static/javascript/album-manager.js photomap/frontend/static/javascript/album.js renamed to photomap/frontend/static/javascript/album-manager.js

@@ -19,7 +19,7 @@ export class AlbumManager {
   static STATUS_CLASSES = {
     SCANNING: "index-status scanning",
     INDEXING: "index-status indexing",
-    UMAPPING: "index-status umapping",
+    UMAPPING: "index-status mapping",
     COMPLETED: "index-status completed",
     ERROR: "index-status error",
     DEFAULT: "index-status",
@@ -802,7 +802,7 @@ export class AlbumManager {
       // Just show the progress UI and let the existing polling handle updates
       setTimeout(() => {
         this.showProgressUI(albumCard); // This will scroll into view
-      }, AlbumManager.AUTO_INDEX_DELAY);
+      }, AlbumManager.AUTO_INDEXING_DELAY);
     }
   }
 
@@ -1023,7 +1023,7 @@ export class AlbumManager {
         if (
           progress.status === "indexing" ||
           progress.status === "scanning" ||
-          progress.status === "umapping"
+          progress.status === "mapping"
         ) {
           console.log(
             `Backend reports indexing already in progress for album: ${albumKey}`
@@ -1274,9 +1274,9 @@ export class AlbumManager {
       status.textContent = progress.current_step || "Scanning for images...";
       status.style.color = "#ff9800"; // Orange for scanning
       estimatedTime.textContent = "";
-    } else if (progress.status === "umapping") {
+    } else if (progress.status === "mapping") {
       status.className = AlbumManager.STATUS_CLASSES.UMAPPING;
-      status.textContent = progress.current_step || "Generating image umap...";
+      status.textContent = progress.current_step || "Generating image map...";
       status.style.color = "#2196f3"; // Blue for umapping
       estimatedTime.textContent = "";
     } else {

photomap/frontend/static/javascript/events.js

@@ -1,6 +1,6 @@
 // events.js
 // This file manages event listeners for the application, including slide transitions and slideshow controls.
-import { checkAlbumIndex } from "./album.js";
+import { checkAlbumIndex } from "./album-manager.js";
 import { eventRegistry } from "./event-registry.js";
 import { initializeGridSwiper } from "./grid-view.js";
 import { deleteImage, getIndexMetadata } from "./index.js";

photomap/frontend/static/javascript/settings.js

@@ -1,6 +1,6 @@
 // settings.js
 // This file manages the settings of the application, including saving and restoring settings to/from local storage
-import { albumManager } from "./album.js";
+import { albumManager } from "./album-manager.js";
 import { exitSearchMode } from "./search-ui.js";
 import { saveSettingsToLocalStorage, setAlbum, state } from "./state.js";
 import { addNewSlide, removeSlidesAfterCurrent } from "./swiper.js";

photomap/frontend/static/javascript/state.js

@@ -1,6 +1,6 @@
 // state.js
 // This file manages the state of the application, including slide management and metadata handling.
-import { albumManager } from "./album.js";
+import { albumManager } from "./album-manager.js";
 import { getIndexMetadata } from "./index.js";
 import { switchAlbum } from "./settings.js";
 

photomap/frontend/static/javascript/umap.js

@@ -1,6 +1,6 @@
 // umap.js
 // This file handles the UMAP visualization and interaction logic.
-import { albumManager } from "./album.js";
+import { albumManager } from "./album-manager.js";
 import { getImagePath, setSearchResults } from "./search.js";
 import { getCurrentSlideIndex } from "./slide-state.js";
 import { state } from "./state.js";