= Installation Instructions for Jade in OSX =

This page describes how to install Jade in OSX. OSX is not officially supported by ROS and the installation might fail for several reasons.

<<TOC(3)>>

== Setup ==
=== Homebrew ===
First, go to http://brew.sh to install homebrew.

Next use homebrew to install additional software.

 . {{{
$ brew update
$ brew install cmake
}}}

And also add our ROS Jade tap and the Homebrew science tap so you can get some non-standard formulae:

 . {{{
$ brew tap ros/deps
$ brew tap osrf/simulation  # Gazebo, sdformat, and ogre
$ brew tap homebrew/versions # VTK5
$ brew tap homebrew/science  # others
}}}

{{{{#!wiki blue/solid
'''Note:''' if you are upgrading from previous ROS distro try:

{{{
$ brew untap ros/DISTRO
}}}
}}}}
{{{#!wiki blue/solid
'''Note:''' It is recommended to use the '''system python''' rather than homebrewed python because of problems with segmentation faults. http://answers.ros.org/question/108431/import-tf-segfaults-python-on-os-x-109-with-brewed-python/
}}}
=== Setup Environment ===
You will need to add these line to your `~/.bashrc` or `~/.bash_profile` to have Homebrew be at the front of the PATH.

 . {{{
export PATH=/usr/local/bin:$PATH
}}}

In order for the above changes to take effect reopen the terminal or run this command:

 . {{{
$ source ~/.bashrc
}}}

You also need to tell python about modules installed by homebrew. The recommended way of doing this are the following commands:

 . {{{
$ mkdir -p ~/Library/Python/2.7/lib/python/site-packages
$ echo "$(brew --prefix)/lib/python2.7/site-packages" >> ~/Library/Python/2.7/lib/python/site-packages/homebrew.pth
}}}

{{{{#!wiki blue/solid
'''Note:''' Earlier versions of homebrew required you to additionally add `/usr/local/share/python` to your `PATH`, so the added line in your `.bashrc` might look like this:
{{{
export PATH=/usr/local/bin:/usr/local/share/python:$PATH
}}}
This is no longer needed.
}}}}
{{{{#!wiki blue/solid
'''Note:''' Previously, it was suggested to set `PYTHONPATH` as such:
{{{
export PYTHONPATH="/usr/local/lib/python2.7/site-packages:$PYTHONPATH"
}}}

This is problematic, because `PYTHONPATH` does not disctinguish between different python version. The recommended way is creating a `.pth` file in the user site-packages as outlined above.
}}}}
=== Additional Tools ===
Finally, we need to install a few ROS python tools using pip.

{{{{#!wiki blue/solid
If you don't already have pip install it with:
{{{
$ sudo easy_install pip
}}}
}}}}
{{{{#!wiki blue/solid

/!\ On OS 10.9 (Mavericks) If pip is installed, check the version installed. If it is not 1.2.1, you will have to delete pip manually and install pip 1.2.1 after deleting:
{{{
$ pip --version
$ sudo easy_install pip==1.2.1
}}}
}}}}
{{{{#!wiki blue/solid

/!\ On OS 10.9 (Mavericks) you might need to install a new version of setuptools before you can install `rosinstall_generator`:
{{{
$ sudo -H pip install -U setuptools
}}}
}}}}
Install the following packages using pip:

 . {{{
$ sudo -H pip install -U wstool rosdep rosinstall rosinstall_generator rospkg catkin-pkg Distribute sphinx
}}}

In order to use rosdep, we need to initialize it:

 . {{{
$ sudo rosdep init
$ rosdep update
}}}

<<Include(jade/Installation/Source,,from="##startinstallation",to="##endinstallation")>>

<<Include(hydro/Installation/Source,,from="##startmaintaining",to="##endmaintaining")>>

<<Include(os/OSX/Homebrew/troubleshooting,,from="##BEGIN_HOMEBREW_TROUBLESHOOT",to="##END_HOMEBREW_TROUBLESHOOT")>>