|
| 1 | +# McGill Rover Documentation |
| 2 | + |
| 3 | +Welcome to the official documentation for **McGill Robotics Rover Team**. This guide will help you understand the structure, systems, and software that power the McGill Rover. Whether you're a team member, contributor, or enthusiast, this documentation aims to provide all the resources you need to get started and stay informed. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +- [Introduction](#introduction) |
| 8 | +- [Project Overview](#project-overview) |
| 9 | +- [Team Structure](#team-structure) |
| 10 | +- [Software Systems](#software-systems) |
| 11 | +- [Hardware Systems](#hardware-systems) |
| 12 | +- [Getting Started](#getting-started) |
| 13 | +- [Contributing](#contributing) |
| 14 | +- [Support](#support) |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## Introduction |
| 19 | + |
| 20 | +The **McGill Rover Team** is dedicated to designing and building advanced rovers to compete in international competitions such as the University Rover Challenge (URC). Our mission is to innovate in robotics while fostering a collaborative environment for students. |
| 21 | + |
| 22 | +## Project Overview |
| 23 | + |
| 24 | +The McGill Rover is a multi-functional robotic platform designed for a variety of planetary exploration tasks. It incorporates systems for mobility, manipulation, science, and autonomy. This rover is a testament to the interdisciplinary collaboration of various engineering and science disciplines. |
| 25 | + |
| 26 | +## Team Structure |
| 27 | + |
| 28 | +Our team is divided into several sub-teams, each focusing on a critical aspect of the rover’s development: |
| 29 | + |
| 30 | +- **Mechanical Team**: Responsible for the structural design and mechanical systems. |
| 31 | +- **Electrical Team**: Handles the power systems, sensors, and communications. |
| 32 | +- **Software Team**: Focuses on control systems, autonomy, and software development. |
| 33 | +- **Science Team**: Develops the rover's ability to collect and analyze scientific data. |
| 34 | + |
| 35 | +## Software Systems |
| 36 | + |
| 37 | +The software for the rover is divided into several modules, each responsible for a specific functionality. This section covers: |
| 38 | + |
| 39 | +- [Control Systems](./software/control-systems.md) |
| 40 | +- [Autonomous Navigation](./software/autonomous-navigation.md) |
| 41 | +- [User Interface](./software/user-interface.md) |
| 42 | + |
| 43 | +We primarily use **ROS (Robot Operating System)** to manage our software components. Please refer to the [Software Setup Guide](./software/setup.md) to configure your environment. |
| 44 | + |
| 45 | +## Hardware Systems |
| 46 | + |
| 47 | +The rover is equipped with state-of-the-art hardware for planetary exploration. Key systems include: |
| 48 | + |
| 49 | +- **Chassis & Suspension**: Designed for rugged terrains. |
| 50 | +- **Manipulator Arm**: Capable of precise movements for handling objects. |
| 51 | +- **Sensors**: LIDAR, cameras, and environmental sensors for data collection. |
| 52 | +- **Power System**: Efficient power management to ensure optimal performance during missions. |
| 53 | + |
| 54 | +Detailed information can be found in the [Hardware Documentation](./hardware/index.md). |
| 55 | + |
| 56 | +## Getting Started |
| 57 | + |
| 58 | +To start working on the McGill Rover, please follow the steps below: |
| 59 | + |
| 60 | +1. Clone the repository: |
| 61 | + ```bash |
| 62 | + git clone https://github.com/mcgill-rover-team/rover.git |
0 commit comments