From 00243ba275f0f7da5ecb7639fa3f18670f8ef426 Mon Sep 17 00:00:00 2001 From: Lidya Langana Date: Wed, 12 Aug 2026 20:52:01 -0700 Subject: [PATCH 1/5] Added Windows batch scripts --- format.bat | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 format.bat diff --git a/format.bat b/format.bat new file mode 100644 index 0000000..b47aff9 --- /dev/null +++ b/format.bat @@ -0,0 +1,24 @@ +@echo off + +if not exist ".venv" ( + echo Creating virtual environment... + uv venv +) + +echo Installing dependencies... +uv pip install -e ".[dev]" + +echo spell checking... +uv run codespell -f -w . + +echo Formatting Python... +uv run black . +uv run isort . +uv run flake8 . +uv run pylint main.py src/ tests/ +uv run ruff check --fix . +uv run ruff format . + +echo Cleaning up... +for /d /r %%d in (.pytest_cache) do @if exist "%%d" rmdir /s /q "%%d" +for /d /r %%d in (__pycache__) do @if exist "%%d" rmdir /s /q "%%d" From d3aec6ef5ee533051f4ccf3e374a459e5ea7cd7f Mon Sep 17 00:00:00 2001 From: Lidya Langana Date: Wed, 12 Aug 2026 21:03:16 -0700 Subject: [PATCH 2/5] Update README with Windows and macOS/Linux setup instructions --- README.md | 144 ++++++++++++++---------------------------------------- 1 file changed, 36 insertions(+), 108 deletions(-) diff --git a/README.md b/README.md index 32313eb..4df17ab 100644 --- a/README.md +++ b/README.md @@ -12,25 +12,17 @@ The goal of this project is to migrate the original **TankController** software --- -## Getting Started +### Getting Started -Follow the steps below to set up your development environment. - -> [!NOTE] -> Windows development requires **Windows Subsystem for Linux (WSL)**. All project commands should be run inside your Linux terminal. - ---- - -## Step 1 — Install Prerequisites - -Before cloning the project, install the following: +Before getting started, install the following: - **Python 3.14+** -- **uv** (Python package manager) - - -- **Tkinter** (required for the local GUI) - -Verify Tkinter by running : +- **uv** — Python package manager + +- **Visual Studio Code** + +- **Tkinter** — required for the local GUI + Verify that Tkinter is installed by running: ```bash python -m tkinter @@ -38,17 +30,9 @@ python -m tkinter If Tkinter is installed correctly, a small GUI window will appear. ---- - -## Step 2 — Complete Platform Setup +#### macOS -Choose the instructions for your operating system. - -### macOS - -Older Python versions may have issues running the GUI. - -Install the Tkinter package for Python 3.14: +If Tkinter is not already installed, install it with: ```bash brew install python-tk@3.14 @@ -56,93 +40,35 @@ brew install python-tk@3.14 --- -### Windows - -**Install WSL** +#### Step 2 — Fork or Clone the Repository -Open **PowerShell as Administrator** and run: - -```powershell -wsl --install -``` - -Restart your computer. - -After restarting: - -1. Open **Ubuntu** from the Start menu. -2. Create your Linux username and password. -3. Update Ubuntu: - -```bash -sudo apt update -sudo apt upgrade -y -``` - -**Install Development Tools** - -```bash -sudo apt install git python3 python3-pip python3-venv build-essential -``` - -**Install uv** - -```bash -curl -LsSf https://astral.sh/uv/install.sh | sh -``` +You can either fork the repository to your own GitHub account or clone it directly. -Reload your shell: +To clone the repository, open a Visual Studio Code Terminal and run: ```bash -source ~/.bashrc -``` - -**Configure Visual Studio Code** - -Install the following Visual Studio Code extensions: - -- Remote - WSL -- Python -- Pylance - -Once the repository has been cloned, open it from your Ubuntu terminal: - -```bash -code . -``` - ---- - -## Step 3 — Clone the Repository - -Clone the repository into your Linux environment. - -```bash -git clone https://github.com/username/TankControllerPico.git +git clone https://github.com/Open-Acidification/TankControllerPico.git cd TankControllerPico ``` +Make sure the project is saved on your local computer. + --- -## Step 4 — Set Up the Development Environment +#### Step 3 — Open the Visual Studio Code Terminal and Run the Project -Create a virtual environment: +In Visual Studio Code, open the integrated terminal by navigating to: -```bash -uv venv -``` +**Terminal → New Terminal** +Then, use the script for your operating system: -Install the project dependencies: +##### Windows -```bash -uv pip install -e ".[dev]" +```powershell +.\run_gui.bat ``` ---- - -## Step 5 — Run the Project - -Launch the local GUI with mocked devices: +##### macOS / Linux ```bash ./run_gui.sh @@ -150,15 +76,9 @@ Launch the local GUI with mocked devices: If the setup was successful, the TankController GUI should open and look similar to the example below. -

- TankController GUI -

+![TankController GUI](images/gui_screenshot.png) -## Features +### Features | View Commands | Set Commands | | ---------------- | ---------------- | @@ -179,14 +99,22 @@ If the setup was successful, the TankController GUI should open and look similar | | Set temperature | | | Set date/time | -## Testing +### Testing To perform Pytest tests for the devices and UI states. -```sh + macOS / Linux + +```bash ./test.sh ``` +Window + +```powershell +.\test.bat +``` + ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): From 868d8844250c955a015582d5014457f6f059075f Mon Sep 17 00:00:00 2001 From: Lidya Langana Date: Thu, 13 Aug 2026 10:37:34 -0700 Subject: [PATCH 3/5] Update the Readme file --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4df17ab..63db5bb 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ The goal of this project is to migrate the original **TankController** software ### Getting Started +#### Step 1 — Install Dependencies + Before getting started, install the following: - **Python 3.14+** @@ -30,7 +32,7 @@ python -m tkinter If Tkinter is installed correctly, a small GUI window will appear. -#### macOS +##### macOS If Tkinter is not already installed, install it with: From 9665972ed2acab7404f2e0a6834d2656258baf75 Mon Sep 17 00:00:00 2001 From: Lidya Langana Date: Thu, 13 Aug 2026 10:39:51 -0700 Subject: [PATCH 4/5] update the Readme file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 63db5bb..d5ae8f4 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ If the setup was successful, the TankController GUI should open and look similar To perform Pytest tests for the devices and UI states. - macOS / Linux +macOS / Linux ```bash ./test.sh From c9745187b61eaaf270ae2f7bc97096f8388ff521 Mon Sep 17 00:00:00 2001 From: Lidya Langana Date: Thu, 13 Aug 2026 10:44:32 -0700 Subject: [PATCH 5/5] testing titles for the Readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d5ae8f4..e05a173 100644 --- a/README.md +++ b/README.md @@ -64,13 +64,13 @@ In Visual Studio Code, open the integrated terminal by navigating to: **Terminal → New Terminal** Then, use the script for your operating system: -##### Windows +##### Windows (Run project) ```powershell .\run_gui.bat ``` -##### macOS / Linux +##### macOS / Linux (Run project) ```bash ./run_gui.sh @@ -105,13 +105,13 @@ If the setup was successful, the TankController GUI should open and look similar To perform Pytest tests for the devices and UI states. -macOS / Linux +#### macOS / Linux (Testing) ```bash ./test.sh ``` -Window +#### Windows (Testing) ```powershell .\test.bat