Installing OpenCPN


Windows XP SP3/Vista/7

  • Download the installation package for Windows from opencpn.org/download.
  • Use the stable release for navigation en route, or if you just started using OpenCPN.
  • Exit all other programs, including your anti virus program - known to create problems in some cases. Unplug your network cable, to be on the safe side.
  • Run the downloaded installer. Re-start your anti-virus. Re-connect the network
  • If upgrading from a previous version of OpenCPN, there is no need to un-install the old version. Simply install the new version and it will upgrade OpenCPN, saving all your existing configuration and preferences.
  • If this is a new installation, click on the Toolbox icon Toolbox Settings and configure your GPS source, chart directories, and other settings.
  • If your installation goes well, but OpenCPN don't start as expected, try to download and install these runtime components.

    • Win 98/ME is supported up to version 2.1.0 From 2.3.0, Windows 98 and Windows ME are no longer supported.
    Win 2000 is supported up to version 2.5.0.
    Win XP SP 2 or 1 is supported up to version 2.5.0. The support was dropped with beta 2.6.1624.

    Old versions of OpenCPN are available on SourceForge.

     

Linux

32/64 bit Ubuntu/Debian Distributions

32 bit Fedora / Cent OS


If you are installing OpenCPN for the first time on a computer with Ubuntu, or any other Linux flavor, you have to go through a few steps to make sure that all dependencies are met. Ubuntu uses "deb" packages and Fedora uses the "rpm" packages.

To make sure that sound works in OpenCPN, we have had to start with an extra step in the Linux installation process. The reason for this is that the libwxgtk Ubuntu package does not contain one option that is essential for OpenCPN.
  • Install a version of libwxgtk2.8-0 that is compiled with support for sdl - Simple DirectMedia Layer. Such versions are available from http://apt.wxwidgets.org.
    Download the correct package for your version of Debian or Ubuntu and

    $sudo dpkg -i ibwxgtk2.8XXXXXX (the proper name of the downloaded version)

    or, follow these instructions: wiki.wxpython.org/InstallingOnUbuntuOrDebian, to add apt.wxwidgets.org as a source for packages.
  • It is recommended that you install the "xcalib" program, that is necessary to dim the screen for night time usage. Use your favorite package manager or just issue $sudo apt-get install xcalib from the command line.
  • On Ubuntu, start "System->Administration->Synaptic". In Synaptic  go to "Settings->Repositories" and tick the box "Community-maintained Open Source software (universe)". Close Synaptic.
  • Download the correct .deb or .rpm from opencpn.org/download.
  • Use the stable release for navigation en route, or if you just started using OpenCPN.
  • Click on the downloaded package. An installation manager will guide you on most Linux distributions. All dependencies should automatically be installed. If you have problems with dependencies, run the recommended command line in the next paragraph.
  • sudo gdebi <downloaded_opencpn_file.deb>. The command "gdebi" will automatically install the dependencies for you.
  • It is also possible to install the package via dpkg or rpm, on the condition that all dependencies are met.To make sure that this is the case on Ubuntu, open a terminal window to get a command line, (Applications->Accessories->Terminal) and copy and paste the following line: sudo apt-get install libwxgtk2.8-0  libwxbase2.8-0 wx-common  libglu1-mesa libgl1-mesa-glx zlib1g bzip2 gpsd gpsd-clients. Then proceed with the commands below
    • For Ubuntu: $ sudo dpkg -i <downloaded_file.deb> 
For Fedora: # sudo yum install --nogpgcheck <downloaded_file.rpm>
    • The binary will be installed to /usr/local/bin/opencpn and the static data used by the program will be in /usr/local/share/opencpn 
  • If this is a new installation, click on the Toolbox icon Toolbox Settings and configure your GPS source, chart directories, and other settings.

Other 32 and 64bit Linux Distributions and the BSD operating systems.

  • Currently other distributions requires compiling the source. This will involve resolving various dependencies and is for folks comfortable with developing on Linux.
  • Download the source from sourceforge.net or directly from the Git server. The SourceForge link for this project is sourceforge.net/projects/opencpn/. More about compiling on Linux here.
  • Interested in maintaining a package for your favorite Linux distribution? Follow the SourceForge link above.
  • This also includes the different BSD distributions. Report your experiences back to the forum.

    •  

Mac OSX

  • Work is underway to bring Mac up to speed with the other major operating systems. Check the download page for the latest available package.

Different versions of OpenCPN

  • Use a "stable", official release for actual navigation. The latest stable release is always available at the top of the download page or from Source Forge.
  • Beta releases are snapshots of the development process, and may contain errors or temporarily be unstable. Show stoppers are normally fixed very quickly however. This is where the latest features first are seen. Most of the time the beta releases are quite stable and the OpenCPN team appreciate it if more experienced users test the releases and report back. The place to report bugs and suggest features is the Tracker. To reach the Tracker from the OpenCPN Web pages click on the "Tracker" tab at the upper right (above the blue bar).
  • To see what version you are using either look in  ?->about or at the top of your display. A lot of information is also available in the log file. See below.


Location of Important Files. Log and config files.

  •  It is important to know the location of the log file and the configuration file, opencpn.conf(Linux) or opencpn.ini (Windows), on your computer. If you ask questions on the forum, there is a fair chance that you will be asked about the content in these files. Once you get familiar with OpenCPN, have a look at the files!
  • Through out this documentation there will be many references to the configuration file, as it often is possible to change the default settings. This is an advanced subject once you are familiar with OpenCPN. All editing in the config files must be done with a text-editor, such as "notepad" in Windows.
  • The configuration file is where all data, that needs to be persistent between sessions, are stored. The logfile keeps tab of what's going on in the current session.                          
  • To find the locations of the files go to the ToolBar click on "About OpenCPN", the button furthest to the right. Look at the bottom  of the "About" Tab, highlighted below. The illustration below is from a Win XP. A quick way to view the logfile is to copy the full file path and then paste this into the address field in a web browser.

  • On Linux the "opencpn.log" is in your home directory.
    The "opencpn.conf" is in a hidden directory, called "opencpn", also in your home directory.
    For a quick way to view the files you can try these commands.
    $gedit `echo $HOME/opencpn.log`
    $gedit `echo $HOME/.opencpn/opencpn.conf`
    Of course you can swap "gedit" for your favorite editor.
  • On Windows 2000, XP and Vista and Windows 7 the two files are more difficult to find, so use the "About" dialog as described above.  Note that some folders in the path to the log and ini files may be hidden. Change the global folder and file settings to make hidden and system files visible, also change settings so that all file extensions are shown.

If something goes wrong

  • If you have installed OpenCPN successfully and later run into trouble there is generally no point in reinstalling. It is a very common reaction among users, but achieves very little.
  • First check your logfile and try to find a hint there.
  • Next step would be to rename the configuration file - opencpn.ini. Close the application first though. When you start OpenCPN again it will be like a new install, no chart directories and all settings are default.
  • If this is successful, please post your old config file, together with full information of what happened and your system, on the Cruisers Forum. To do this, first rename the file by adding ".doc" to the end of the file name.
  • This will help the OpenCPN developers  to understand what's going on.