From 8892bb3fe3927c63f2a388e4104dbce8997c9d56 Mon Sep 17 00:00:00 2001 From: Ethan Li Date: Wed, 8 May 2024 19:24:40 -0700 Subject: [PATCH] Fix issues in `README.md`; bump Docker container image in Compose app --- README.md | 23 +++-------------------- pkg/compose.yml | 2 +- 2 files changed, 4 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 81f7bb5..882ecc5 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,7 @@ Features: Before running this application, make sure you have Docker installed on your system. If you do not have Docker, you can download it from the [official Docker website](https://docs.docker.com/get-docker/). -### Installation for local development - -To get this application up and running, follow these steps: +### Local Docker image build for local testing #### Cloning the Repository @@ -76,13 +74,6 @@ your computer. Setup instructions are available that currently `forklift` is only tested for Linux computers, and that Forklift is still an experimental prototype. -#### Deployment - -The instructions below assume that you are using a version of the `forklift` tool which is greater -than or equal to v0.7.0 (but less than v0.8.0, which has not been released yet); other versions of -the `forklift` tool may behave differently and thus may require different commands than what is -described below: - #### First-time deployment You can clone, stage, and apply the latest commit of this Forklift pallet to your computer, by @@ -127,16 +118,8 @@ forklift stage apply #### Operation -After you have applied the pallet so that the containers are running, you can access the streamlit -demo app from your web browser at . - -The segmenter loads input datasets - and saves output files - in folders within -`~/.local/share/planktoscope/data`, instead of the usual path on PlanktoScopes (`/home/pi/data`). -Similarly, logs are saved in `~/.local/share/planktoscope/device-backend-logs` instead of -`/home/pi/device-backend-logs`. The simplest way to add input datasets and download EcoTaxa export -archives (working around issues with file permissions between your user account and the `root` user -used for running the segmenter) will be to use the filebrowser app in your web browser, at -. +After you have applied the pallet so that the streamlit demo app's container is running, you can +access the streamlit demo app from your web browser at . Before you can use the streamlit demo app, you will need to download a classification model file (e.g. ) diff --git a/pkg/compose.yml b/pkg/compose.yml index 227bd39..58dc10f 100644 --- a/pkg/compose.yml +++ b/pkg/compose.yml @@ -1,6 +1,6 @@ services: server: - image: ghcr.io/planktoscope/streamlit-classification-app:sha-a83b7ea + image: ghcr.io/planktoscope/streamlit-classification-app:sha-15ff307 volumes: - ~/.local/share/planktoscope/models/:/app/models