Skip to content

Commit 1d3f4e1

Browse files
authored
Stop building desktop images (#582)
After improving the DX, I have found that a GUI is not necessary for development and perhaps counterproductive. The developer environment should be as close as possible to the end product. The idea of a desktop image was to ease connecting the Raspberry to the network, but improvements were made in that area and I believe we should rather focus on making sure it's easy to connect any PlanktoScope to the network. We now have a [developer mode](https://github.com/PlanktoScope/PlanktoScope/blob/master/documentation/docs/community/contribute/tips-and-tricks.md#development-environment) that can be setup on any PlanktoScope image and enable extra developer features. A GUI can still be useful in some scenarios, so I have documented how to get it up and running for the [Tips and Tricks](https://github.com/PlanktoScope/PlanktoScope/blob/master/documentation/docs/community/contribute/tips-and-tricks.md) page. I also believe that reducing the number of configurations (whether officially supported or not) will allow us to iterate and improve the PlanktoScope faster. With the end goal of building a single image. Finally, this will (even so slightly) reduce our environmental impact. See also this conversation #571 (comment)
1 parent 43289d1 commit 1d3f4e1

File tree

3 files changed

+13
-58
lines changed

3 files changed

+13
-58
lines changed

.github/workflows/build-os-bookworm-dx.yml

Lines changed: 0 additions & 54 deletions
This file was deleted.

documentation/docs/community/contribute/tips-and-tricks.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ This page provides useful snippets and how-tos while developing software for the
1717

1818
## Development OS
1919

20-
On the Raspberry, we recommend using our developer image which is built upon [Raspberry Pi OS with desktop 64-bit](https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-64-bit).
20+
You can find the latest build of PlanktoScope OS in [actions](https://github.com/PlanktoScope/PlanktoScope/actions/workflows/build-os-bookworm.yml?query=branch%3Amaster)
2121

22-
You can find the latest build in [actions](https://github.com/PlanktoScope/PlanktoScope/actions/workflows/build-os-bookworm-dx.yml?query=branch%3Amaster)
22+
It is built upon [Raspberry Pi OS Lite 64-bit](https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-64-bit).
2323

2424
1. Choose the branch (e.g. `master`)
2525
2. Click on the most recent action in the table
@@ -28,6 +28,17 @@ You can find the latest build in [actions](https://github.com/PlanktoScope/Plank
2828

2929
See [Backup and Restore SD Card image](#backup-and-restore-sd-card) below to write the `.img.xz` file to the sdcard
3030

31+
## Graphical UI
32+
33+
To install the graphical desktop similar to what you find on the desktop edition of Raspberry Pi OS proceed as following:
34+
35+
```sh
36+
sudo apt install raspberrypi-ui-mods
37+
# Change the boot option
38+
sudo raspi-config # System Options -> Boot -> Desktop GUI
39+
reboot
40+
```
41+
3142
## Development Environment
3243

3344
To setup the recommended development environment, run the following commands.

documentation/docs/setup/software/nonstandard-install.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@ If you need help determining this information, please post a message in the `#6-
4343

4444
The standard PlanktoScope software SD card images are built on the Raspberry Pi OS Lite image for the appropriate release version of Raspberry Pi OS. The Lite image only provides a command-line interface, without a graphical desktop environment or web browser. Because the PlanktoScope's graphical user interface must be accessed from a web browser, you might prefer to use the "Raspberry Pi OS with desktop" image in order to have a graphical desktop environment with a web browser. This would allow you to operate the PlanktoScope by plugging in a display, keyboard, and mouse to your Raspberry Pi; otherwise, you will have to connect to the PlanktoScope from another device over Ethernet or Wi-Fi in order to access the PlanktoScope's graphical user interface.
4545

46-
We also build and use (but we don't officially release or support) developer-focused SD card images (which we label "-dx" as an abbreviation for "developer experience") which come with the Raspberry Pi OS graphical desktop environment (which is called "Raspberry Pi OS with desktop" in the Raspberry Pi OS download page). To learn more about these `-dx` images, please post a message in the `#6-dev-software` channel on the PlanktoScope Slack.
47-
4846
#### Download the correct Raspberry Pi OS image
4947

5048
Once you have determined the appropriate release name, release date, and variant of Raspberry Pi OS, you should download the appropriate 64-bit version of Raspberry Pi OS from the [Raspberry Pi OS download page](https://www.raspberrypi.com/software/operating-systems/). If the appropriate release date is not shown on that page, you may need to use the "Archive" link in the section of that page corresponding to the appropriate release name and variant; with the "Archive" link, you can choose an image with the appropriate release date. If you need help, please post a message in the `#6-dev-software` channel on the PlanktoScope Slack and mention the release name, release date, and variant which you are trying to download.

0 commit comments

Comments
 (0)