Files
paparazzi/doc/sphinx/source/getting_started/install.rst
T
Fabien-B 41998a12b3 [doc] Update pprzcenter and GCS presentation. (#3229)
* [doc] Update pprzcenter and GCS presentation.
Simplify install instructions.

* [doc] Windows install + some fixes
2024-01-26 09:01:13 +01:00

97 lines
2.9 KiB
ReStructuredText

.. quickstart install
============
Installation
============
Paparazzi runs best on **Ubuntu 16.04 or higher**, so this quick installation guide is for Ubuntu users.
If you want to run it on windows, see the instructions: `Install on Windows`_.
Open a terminal and execute each lines below. If one fails, ask for help on gitter.
Version specific prerequisites
------------------------------
**If you have Ubuntu 20.04 or 22.04:**
.. code-block:: bash
sudo apt-get install python-is-python3 gcc-arm-none-eabi gdb-multiarch
**If you have Ubuntu 18.04 or lower:**
.. code-block:: bash
sudo add-apt-repository -y ppa:team-gcc-arm-embedded/ppa
sudo apt-get install gcc-arm-embedded
sudo apt-get install python3-lxml python3-numpy
sudo apt-get update
Install Paparazzi
-----------------
Add paparazzi apt-repository and install dependencies:
.. code-block:: bash
sudo add-apt-repository -y ppa:paparazzi-uav/ppa
sudo apt-get update
sudo apt-get -f -y install paparazzi-dev paparazzi-jsbsim dfu-util pprzgcs
.. note:: If you are on Ubuntu 18.04, ``pprzgcs`` is not available, just remove it from the last line. Also launch using ``paparazzi -legacy`` mode
Clone the repository:
.. code-block:: bash
cd ~
git clone --origin upstream https://github.com/paparazzi/paparazzi.git
cd ~/paparazzi
git remote update -p
sudo cp conf/system/udev/rules/*.rules /etc/udev/rules.d/
sudo udevadm control --reload-rules
*Optionnal:* checkout on a stable version:
.. code-block:: bash
git checkout -b v6.3 upstream/v6.3
Get the submodules and build Paparazzi. This step might take a long time the first time you launch it:
.. code-block:: bash
make -j1
.. note::
The ``-j1`` argument may not be necessary, but if you are not familiar with paparazzi, its safer to use it. However, it will make paparazzi build much slower.
Finally, launch Paparazzi with
.. code-block:: bash
./paparazzi
If all went well the Paparazzi Center should now be running. Please continue to the next page for a guided tour.
Install on Windows
------------------
Paparazzi do not run natively on windows, but you can run it in the *Windows Subsystem for Linux*.
Install the Windows Subsystem for Linux and the Ubuntu distribution by following the Microsoft documentation,
then install paparazzi like on a regular Ubuntu.
In older versions of WLS, you may need to install an X server like `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_
or `Xming <https://sourceforge.net/projects/xming/>`_.
You will then need to set the *DISPLAY* environment variable to point at the X server running on your Windows 10 PC :
.. code-block:: bash
export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2; exit;}'):0
.. note::
The **Windows Terminal** application is very usefull as it can have multiple tabs and allows you to easily switch between Bash and Powershell.