flimkit 0.13.4__tar.gz → 0.13.5__tar.gz

{flimkit-0.13.4 → flimkit-0.13.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flimkit
-Version: 0.13.4
+Version: 0.13.5
 Summary: Fluorescence lifetime imaging analysis: reading, fitting, phasors and stitching
 Author-email: Alex Hunt <alexander.hunt@ed.ac.uk>
 License-Expression: MIT
@@ -133,25 +133,36 @@ python install.py --dev
 
 ## Docker / TrueNAS SCALE
 
-A pre-built image is available on Docker Hub. It runs the full desktop GUI in a browser via xpra (no installation needed on the client).
+A pre-built image is available on Docker Hub. It runs FLIMKit with the [web UI](https://github.com/FLIMKit/flimkit-web-ui), so the whole app is used from a browser with nothing installed on the client.
 
 **Pull and run:**
 
 ```bash
 docker run -d \
   -p 14500:14500 \
+  -e FLIMKIT_PASSWORD=choose-a-password \
   -v /path/to/your/data:/data \
+  -v /path/to/flimkit-config:/root/.flimkit \
   --name flimkit \
   alex1075/flimkit:latest
 ```
 
-Then open **http://localhost:14500** in your browser. PTU files and data should be placed in the folder you mount to `/data` - use the file dialog inside the app to navigate there.
+Then open **http://localhost:14500** and log in as `flimkit` with that password. Put PTU files and data in the folder you mount to `/data` and use the Browse buttons in the page to navigate there. The config mount keeps expert settings, preferences and recent files when the container is recreated.
+
+| Variable | Default | Effect |
+|---|---|---|
+| `FLIMKIT_PASSWORD` | not set | Password for the web UI (user `flimkit`) and for the desktop view. Without it, anyone who can reach the port can use FLIMKit and browse `/data`. |
+| `FLIMKIT_DESKTOP` | `0` | Set to `1` to also serve the full desktop through noVNC on port 14501, for the few windows the web UI does not cover. Publish that port too. |
+| `FLIMKIT_GEOMETRY` | `1440x900` | Size of the virtual screen FLIMKit draws on |
+| `TZ` | `Etc/UTC` | Time zone for log timestamps |
+
+The container reports healthy once the web UI answers on `/healthz`.
 
 **TrueNAS SCALE (Custom App):**
 
 1. Apps → Discover Apps → Custom App
 2. Paste the contents of `docker/docker-compose.yaml` from this repo
-3. Edit the volume paths to match your pool (e.g. `/mnt/tank/microscopy:/data`)
+3. Edit the volume paths to match your pool (e.g. `/mnt/tank/microscopy:/data`) and uncomment `FLIMKIT_PASSWORD` with a password of your own
 4. Deploy - TrueNAS will pull the image automatically
 
 **Build from source** (required if you want to push your own changes):

{flimkit-0.13.4 → flimkit-0.13.5}/README.md

@@ -71,25 +71,36 @@ python install.py --dev
 
 ## Docker / TrueNAS SCALE
 
-A pre-built image is available on Docker Hub. It runs the full desktop GUI in a browser via xpra (no installation needed on the client).
+A pre-built image is available on Docker Hub. It runs FLIMKit with the [web UI](https://github.com/FLIMKit/flimkit-web-ui), so the whole app is used from a browser with nothing installed on the client.
 
 **Pull and run:**
 
 ```bash
 docker run -d \
   -p 14500:14500 \
+  -e FLIMKIT_PASSWORD=choose-a-password \
   -v /path/to/your/data:/data \
+  -v /path/to/flimkit-config:/root/.flimkit \
   --name flimkit \
   alex1075/flimkit:latest
 ```
 
-Then open **http://localhost:14500** in your browser. PTU files and data should be placed in the folder you mount to `/data` - use the file dialog inside the app to navigate there.
+Then open **http://localhost:14500** and log in as `flimkit` with that password. Put PTU files and data in the folder you mount to `/data` and use the Browse buttons in the page to navigate there. The config mount keeps expert settings, preferences and recent files when the container is recreated.
+
+| Variable | Default | Effect |
+|---|---|---|
+| `FLIMKIT_PASSWORD` | not set | Password for the web UI (user `flimkit`) and for the desktop view. Without it, anyone who can reach the port can use FLIMKit and browse `/data`. |
+| `FLIMKIT_DESKTOP` | `0` | Set to `1` to also serve the full desktop through noVNC on port 14501, for the few windows the web UI does not cover. Publish that port too. |
+| `FLIMKIT_GEOMETRY` | `1440x900` | Size of the virtual screen FLIMKit draws on |
+| `TZ` | `Etc/UTC` | Time zone for log timestamps |
+
+The container reports healthy once the web UI answers on `/healthz`.
 
 **TrueNAS SCALE (Custom App):**
 
 1. Apps → Discover Apps → Custom App
 2. Paste the contents of `docker/docker-compose.yaml` from this repo
-3. Edit the volume paths to match your pool (e.g. `/mnt/tank/microscopy:/data`)
+3. Edit the volume paths to match your pool (e.g. `/mnt/tank/microscopy:/data`) and uncomment `FLIMKIT_PASSWORD` with a password of your own
 4. Deploy - TrueNAS will pull the image automatically
 
 **Build from source** (required if you want to push your own changes):

{flimkit-0.13.4 → flimkit-0.13.5}/flimkit/_version.py

@@ -1,4 +1,4 @@
-__version__ = '0.13.4'
+__version__ = '0.13.5'
 fitter_version = '20'
 
 roadmap = '''Flim program roadmap:
@@ -43,5 +43,6 @@ Need to add Phasor once added to the codebase, and update version to 1.0. And ad
 0.13.2 -> the desktop GUI starts on a Tk 9 interpreter. The Windows python.org build of Python 3.14 ships Tk 9.0 where the macOS build still ships 8.6, and two GUI dependencies were built for Tcl 8.6 only, so the window died before it opened with either an unloadable tkdnd library or an invalid command name set_theme, depending on what was installed. tkinterdnd2 moves to 0.6.2 or newer and sv-ttk joins the gui extra, both of which load on Tk 8.6 and Tk 9. FLIMKit also falls back to a plain window rather than dying when a theme or a Tcl package fails at run time, which it could not do before because it chose its path from whether the imports had worked and both libraries import cleanly before failing inside Tcl. No fitted number changes.
 0.13.3 -> OME-Zarr joins PNG and OME-TIFF in the image export. One store per export, named after the scan, holding a single (c, y, x) float32 array with every exported map as a named channel, so intensity and lifetime are two channels of one image rather than two files. The pixel size and the summed-fit summary go into the store metadata, and the pixel size also fills the NGFF scale transform, so exported maps carry their calibration and their fit numbers. Chunks are compressed with Blosc/zstd, which puts a 512 square float32 intensity and lifetime pair at about a third of the two uncompressed OME-TIFFs. zarr is a base dependency rather than an extra, so the pip install and the compiled application both carry it. No fitted number changes, so fitter_version stays at 20.
 0.13.4 -> the desktop GUI no longer dies on a Tk 9 interpreter when the Sun Valley theme fails to load. Tk 9 on macOS queues an idle handler when a root window is created and does not cancel it when that root is destroyed, so the fallback path, which threw the themed root away and built a second one, segfaulted inside showRootWindow on the first update_idletasks rather than opening a window. The fallback now reuses the root the themed attempt had already built, clearing its children, because only the theme had failed and the window itself was sound. Tk 8.6 survived the destroy and rebuild, which is why this only showed up on a fresh install. No fitted number changes, so fitter_version stays at 20.
+0.13.5 -> the Docker images serve FLIMKit through flimkit-web-ui instead of streaming the desktop over noVNC. Port 14500 opens the web page, which drives the same Tk window on the virtual display, so a TrueNAS app keeps its address. FLIMKIT_PASSWORD protects the page with HTTP Basic authentication, the noVNC desktop stays available behind FLIMKIT_DESKTOP=1 on port 14501, and the images gain a /healthz health check. docker-compose.yaml mounts the config at /root/.flimkit, where FLIMKit reads it, rather than at /config, which nothing read. No fitted number changes, so fitter_version stays at 20.
 1.0.0 -> release version with all core features implemented and tested
 1.5.0 (or 2.0) -> validation of fitting results with known fluorophores.'''

{flimkit-0.13.4 → flimkit-0.13.5}/flimkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flimkit
-Version: 0.13.4
+Version: 0.13.5
 Summary: Fluorescence lifetime imaging analysis: reading, fitting, phasors and stitching
 Author-email: Alex Hunt <alexander.hunt@ed.ac.uk>
 License-Expression: MIT
@@ -133,25 +133,36 @@ python install.py --dev
 
 ## Docker / TrueNAS SCALE
 
-A pre-built image is available on Docker Hub. It runs the full desktop GUI in a browser via xpra (no installation needed on the client).
+A pre-built image is available on Docker Hub. It runs FLIMKit with the [web UI](https://github.com/FLIMKit/flimkit-web-ui), so the whole app is used from a browser with nothing installed on the client.
 
 **Pull and run:**
 
 ```bash
 docker run -d \
   -p 14500:14500 \
+  -e FLIMKIT_PASSWORD=choose-a-password \
   -v /path/to/your/data:/data \
+  -v /path/to/flimkit-config:/root/.flimkit \
   --name flimkit \
   alex1075/flimkit:latest
 ```
 
-Then open **http://localhost:14500** in your browser. PTU files and data should be placed in the folder you mount to `/data` - use the file dialog inside the app to navigate there.
+Then open **http://localhost:14500** and log in as `flimkit` with that password. Put PTU files and data in the folder you mount to `/data` and use the Browse buttons in the page to navigate there. The config mount keeps expert settings, preferences and recent files when the container is recreated.
+
+| Variable | Default | Effect |
+|---|---|---|
+| `FLIMKIT_PASSWORD` | not set | Password for the web UI (user `flimkit`) and for the desktop view. Without it, anyone who can reach the port can use FLIMKit and browse `/data`. |
+| `FLIMKIT_DESKTOP` | `0` | Set to `1` to also serve the full desktop through noVNC on port 14501, for the few windows the web UI does not cover. Publish that port too. |
+| `FLIMKIT_GEOMETRY` | `1440x900` | Size of the virtual screen FLIMKit draws on |
+| `TZ` | `Etc/UTC` | Time zone for log timestamps |
+
+The container reports healthy once the web UI answers on `/healthz`.
 
 **TrueNAS SCALE (Custom App):**
 
 1. Apps → Discover Apps → Custom App
 2. Paste the contents of `docker/docker-compose.yaml` from this repo
-3. Edit the volume paths to match your pool (e.g. `/mnt/tank/microscopy:/data`)
+3. Edit the volume paths to match your pool (e.g. `/mnt/tank/microscopy:/data`) and uncomment `FLIMKIT_PASSWORD` with a password of your own
 4. Deploy - TrueNAS will pull the image automatically
 
 **Build from source** (required if you want to push your own changes):