Skip to content

Commit

Permalink
Add noetic instructions (#5)
Browse files Browse the repository at this point in the history
* Add noetic instructions
* Add correct hyperlink
  • Loading branch information
kanishkegb authored Aug 18, 2023
1 parent 445981c commit 9008659
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Python - Gazebo Simulation Environment for a UAV with Geometric Control

This repository include Python codes for the position control a UAV in a Gazebo simulation environment, using [geometric controllers](https://github.com/fdcl-gwu/uav_geometric_control).
This repository includes Python codes for the position control a UAV in a Gazebo simulation environment, using [geometric controllers](https://github.com/fdcl-gwu/uav_geometric_control).

## Features
* Developed using Python
Expand Down Expand Up @@ -64,16 +64,23 @@ This repository include Python codes for the position control a UAV in a Gazebo
* Replace that with an unused mode in the `calculate_desired` function inside the `Trajectory` class.

## Setting-up

:bangbang: If you are running this on a virtual machine, please make sure that Gazebo can run at real-time speed.
It is known that this simulation exhibits unintended behavior if the "real-time factor" of the Gazebo simulation is not closer to 1.0 (See [issue#3](https://github.com/fdcl-gwu/uav_simulator/issues/3)).

### Dependencies
1. [ROS](http://wiki.ros.org/): this repository has been developed using ROS Melodic, on Ubuntu 18.04.
1. [ROS](http://wiki.ros.org/): this repository has been developed using ROS Noetic, on Ubuntu 20.04. If you are on ROS Melodic with Ubuntu 18.04, please checkout `ros-melodic` branch before installing dependencies.
1. Python GTK libraries for GUI (not required if you opt to not to use the GUI)
```sh
sudo apt-get install python-gtk2-dev
sudo apt-get install python3-pip python3-gi
```
1. Python modules: these libraries must be installed in the system
1. NumPy
1. Pandas
1. Matplotlib
```sh
python3 -m pip install numpy pandas matplotlib
```

### Setting-up the repository
1. Clone the repositroy.
Expand Down Expand Up @@ -108,7 +115,8 @@ You only need to do the followings once (unless you change the Gazebo plugins)
```sh
python3 main.py
```
If you change the Python code, simply re-run the Python code
If you change the Python code, simply re-run the Python code.
The code has been tested with Python3.8.10, which comes default with Ubuntu 20.04.
![Terminal](images/running.gif)
Expand Down
2 changes: 1 addition & 1 deletion src/CMakeLists.txt

0 comments on commit 9008659

Please sign in to comment.