..
.. Copyright (c) 2004-2014 Laboratório de Sistemas e Tecnologia Subaquática and Authors
.. All rights reserved.
.. Faculdade de Engenharia da Universidade do Porto
.. Departamento de Engenharia Electrotécnica e de Computadores
.. Rua Dr. Roberto Frias s/n, 4200-465 Porto, Portugal
..
.. For more information please see <http://whale.fe.up.pt/neptus>.
.. 
.. $Id:: install.rst 548 2014-06-01 13:21:35Z pdias                       $:

.. _sec_install:

.. index:: 
  single: install

Installing Neptus
*****************

This section will guide you through the process of installing Neptus on both *Windows* and *Linux* operating systems.

Minimum Requirements
====================

In order to run Neptus, you should have at least 1 GB of available RAM memory, a 1GHz CPU and 512 MB of 
hard drive space. For better performance, it is recommended that you have 2 GB of available RAM memory, 
an *Intel Core i3* or better CPU, an accelerated graphics card (for 3D visualizations) and extra disk
space for storing incoming vehicle data.

Neptus supports both 32 and 64 bit architectures and is continuously tested under *Windows* and *Linux* 
operating systems.


Installing
==========

Installing and Running Neptus Under Windows
-------------------------------------------

To install Neptus under Windows, it is necessary to download and execute the installer for your architecture
(e.g. :file:`Neptus*.exe`, the :file:`'*'` part depends on the file name for the version to install). After reading 
and accepting the license (a copy of this license can be found in the legal folder of Neptus installation 
directory), you can opt for the directory where to install Neptus (by default this is :file:`C:\\Neptus*`). 
After the installation process is complete, you can launch Neptus from the Start Menu.

.. WARNING:: |admonition_warning|
	Under **Windows**, for the time being, don't install Neptus in :file:`Program Files` folder. Choose to install it on your system root folder.

Installing and Running Neptus Under Linux
-----------------------------------------

To install Neptus under Linux, it is necessary to download and execute the installer for your architecture 
(e.g. :file:`Neptus*.sh`). To run this installer, you can execute the command: ::

	sh ./Neptus*.sh

As a result, a new folder, named :file:`Neptus*` will be created with all required files to run Neptus.
To execute Neptus, go to the installation directory and execute the command: ::

	./neptus.sh

If you have problems with the sound not working you can use the alternative way to start with the command: ::

	padsp ./neptus.sh