MATE ROV 2025 Dashboard

Contributors

• Giovanni Terefi
• Brian Cao
• Ada Lin
• Derrick Ma
• Vincent Tan
• Saad Ismail
• Randy Sim

Requirements

• PyQt5

  pip install PyQt5

Project Structure

.
├── Components
│   ├── __init__.py
│   └── component.py
├── README.md
└── app.py

app.py will be the primary driver of our program; it is where the main application window will be called and executed.

The Components folder will store all of our individual components/widgets, which will be called in app.py.

A sample component, called component.py has been created in order to help you understand how a PyQt5 widget works.

Each component will be its own class; they do not necessarily have to be contained within their own Python file.

How to contribute

Working from your local machine

1. Clone this repository to your local machine (ideally in a folder for SBRT):

   SSH (recommended):

   git clone git@github.com:sbroboticsteam/MATE-ROV-GUI.git 

   HTTPS:

   git clone https://github.com/sbroboticsteam/MATE-ROV-GUI.git

2. To start working, navigate to the project directory:

   cd MATE-ROV-GUI

Branching Workflow

1. Create a feature branch from main:

   git checkout main
   git pull origin main
   git checkout -b component-name

2. Work on your feature branch and push your changes:

   git add <component-name>
   git commit -m "Your commit message"
   git push origin component-name

3. Open a pull request to merge your changes into main.

Creating pull request

Once your feature branch is pushed to GitHub, follow these steps to create a pull request:

1. Go to the GitHub page of the repository: MATE ROV GUI.

2. Click on the Pull requests tab.

3. Click the New pull request button.

4. Select your feature branch (compare branch) and ensure main is selected as the base branch.

5. Provide a clear title for the pull request (e.g., "Add camera display UI").

6. In the description, include details about the changes you made.

7. Submit the pull request by clicking Create pull request.

8. Once approved, the changes in your branch will be merged into the main branch.