Skip to content

Commit

Permalink
Fix issues in README.md; bump Docker container image in Compose app
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanjli committed May 9, 2024
1 parent 15ff307 commit 8892bb3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 <http://localhostps/streamlit-demo>.

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
<http://localhost:9000>.
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 <http://localhost/ps/streamlit-demo>.

Before you can use the streamlit demo app, you will need to download a classification model file
(e.g. <https://github.com/PlanktoScope/streamlit-classification-app/releases/download/models%2Fdemo-1/effv2s_no_norm_DA+sh_20patience_256x256_50ep_loss.pth>)
Expand Down
2 changes: 1 addition & 1 deletion pkg/compose.yml
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 8892bb3

Please sign in to comment.