Athena Code

This repository contains all the code for UMDLoop's 2025-26 rover, Athena.

When cloning, be sure to use git clone --recursive [URL to Git repository] to pull in the submodules found in src/third-party. Alternatively, run git submodule update --init --recursive if you have already cloned.

How To Contribute

Learning Git

If you're new to Git and GitHub, start with this beginner-friendly tutorial: GitHub's Hello World Guide

For a more comprehensive introduction, check out: Git and GitHub Tutorial for Beginners

Setting up Git

Before you can contribute, you'll need to have Git installed and configured on your machine:

1. Install Git - Follow GitHub's guide to set up Git on your system
2. Configure Git - Set your username and email that will be associated with your commits

SSH Keys

To securely authenticate with GitHub without entering your password each time, set up SSH keys:

1. Check for existing SSH keys - See if you already have SSH keys: Checking for existing SSH keys
2. Generate a new SSH key - If needed, create a new SSH key pair: Generating a new SSH key
3. Add SSH key to GitHub - Upload your public key to your GitHub account: Adding a new SSH key to your GitHub account

Making a Pull Request (PR)

Once you're set up, here's how to contribute your changes:

1. Fork the repository - Create your own copy of the repository: Fork a repo

2. Clone your fork - Download your forked repository to your local machine using git clone.

3. Create a feature branch - Make a new branch for your specific feature or fix: Creating and deleting branches

   git checkout -b feature/your-feature-name

4. Make your changes - Write your code, test it thoroughly, and commit your changes

5. Push to your fork - Upload your feature branch to your GitHub fork

   git push origin feature/your-feature-name

6. Open a Pull Request - Submit your changes for review: Creating a pull request from a fork

Your PR will be reviewed by your lead, and once approved, it will be merged into the main codebase!

Workspace Startup:

1. Navigate to your workspace

2. Install required dependencies

rosdep install --from-paths src y --ignore-src

3. Build the workspace

colcon build --symlink-install

4. Set up can0

Hardware:

./src/athena-code/src/tools/scripts/can_setup.sh 

Virtual:

./src/athena-code/src/tools/scripts/virtual_can_setup.sh

5. Launch a subsystem!

./src/athena-code/src/tools/scripts/<subsystem>_launch.sh