Digital Twin of Lunar/Mars Rover

Version: v1.0.0
Communication system simulation for lunar and Mars rover operations

---

Getting Started

Clone the Repository

git clone git@bitbucket.org:lunar_outpost_field_session/communications_model.git

---

Docker Setup

Build the Container

1. Start the ros2:humble container in Docker Desktop

2. Build the Docker image:

   docker build

3. Run the container with volume mount:

   docker run -v "<absolute path to your local repository>:/home/communications_model/src" --rm -it ros:humble

Note: Replace <absolute path to your local repository> with your actual local path

Container Environment

Navigate to the working directory:

cd /home/communications_model

Verify you're running as root:

whoami  # Should return: root

---

Build & Run

Build the Workspace

colcon build

Source the Setup

source install/setup.bash

Run a Node

ros2 run <package name> <node name>

---

Launch Components

Terminal 1: Radio Model

ros2 launch radio_model radio.launch.py

---

Testing

Run All Unit Tests

colcon build
colcon test

View Specific Test Failures

colcon test --packages-select <package name> --event-handlers console_direct+

---

Code Quality

Fix C++ Code Smells (Automated)

ament_uncrustify --reformat <dir>

View Python Code Smells (Manual Resolution Required)

ament_flake8 <dir>

Doxygen Documentation

To Run Doxygen Commands and View Documentation

1. Run doxygen doxygen.txt in the main repository
2. Cd into doxygen_docs
3. Cd into html
4. Ls and verify that index.html exists
5. On Mac, run open index.html to view the documentation in a browser

---

Documentation

• ROS2 Documentation: docs.ros.org
• Docker Documentation: docs.docker.com

---