From 2cc4a2ad0fdf6a52d96b5fb902843e1c132affe1 Mon Sep 17 00:00:00 2001 From: Ethan Li Date: Tue, 7 May 2024 13:27:10 -0400 Subject: [PATCH] Update `README.md` for changes from the previous commit --- README.md | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7fa04bb..b9ab266 100644 --- a/README.md +++ b/README.md @@ -46,18 +46,6 @@ If your user is [in the `docker` group](https://docs.docker.com/engine/install/l forklift pallet switch --apply github.com/PlanktoScope/pallet-segmenter@edge ``` -Then you can access the Node-RED dashboard from your web browser at -, or you can programmatically interact with the segmenter over MQTT via - (e.g. using [github.com/PlanktoScope/cli](https://github.com/PlanktoScope/cli)). -You can also access the Node-RED dashboard editor from your web browser at . - -The segmenter loads input datasets - and saves output files - in `~/.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 in your web browser, at . - #### Subsequent deployment Because the `forklift` tool uses [Docker Compose](https://docs.docker.com/compose/) to manage the @@ -74,6 +62,30 @@ Or if your user is in the `docker` group: forklift stage apply ``` +#### Operation + +After you have applied the pallet so that the containers are running, you can access the Node-RED +dashboard from your web browser at , or you can programmatically interact +with the segmenter over MQTT via (e.g. using +[github.com/PlanktoScope/cli](https://github.com/PlanktoScope/cli)). +You can also access the Node-RED dashboard editor 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 +. + +Before you can use the Node-RED dashboard, you will need to create a folder at +`~/.local/share/planktoscope/data/img` (which you can do by just using the filebrowser app to create +a new folder named `img` in the top level, at ), and then you should +upload/copy your input datasets into that folder. Then you can press the "Update acquisition's +folder list" button in the Node-RED dashboard, which should cause your input datasets to be listed +in the dashboard. + ### Forking To make your own copy of this repository for experimentation, you should fork this repository to a