Skip to content

Commit

Permalink
Add Windows installation (#194)
Browse files Browse the repository at this point in the history 
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>

Co-authored-by: John Shepherd <john@openrobotics.org>
  • Loading branch information
@mabelzhang
mabelzhang and John Shepherd authored Jan 21, 2021
1 parent 74f1d31 commit b1876f0
Show file tree
Hide file tree
Showing 2 changed files with 198 additions and 113 deletions.
52 changes: 0 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,6 @@ designed to support simulation and rapid development of robot applications.

[Usage](#usage)

[Documentation](#documentation)

[Testing](#testing)

[Folder Structure](#folder-structure)

[Code of Conduct](#code-of-conduct)
Expand Down Expand Up @@ -145,54 +141,6 @@ sudo update-alternatives --install \
Please refer to the [examples directory](https://github.com/ignitionrobotics/ign-physics/raw/master/examples/).
# Documentation
API and tutorials can be found at [https://ignitionrobotics.org/libs/physics](https://ignitionrobotics.org/libs/physics).
You can also generate the documentation from a clone of this repository by following these steps.
1. You will need Doxygen. On Ubuntu Doxygen can be installed using
```
sudo apt-get install doxygen
```
2. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics2
```
3. Configure and build the documentation.
```
cd ign-physics; mkdir build; cd build; cmake ../; make doc
```
4. View the documentation by running the following command from the build directory.
```
firefox doxygen/html/index.html
```
# Testing
Follow these steps to run tests and static code analysis in your clone of this repository.
1. Follow the [source install instruction](#source-install).
2. Run tests.
```
make test
```
3. Static code checker.
```
make codecheck
```
# Folder Structure
Refer to the following table for information about important directories and files in this repository.
Expand Down
259 changes: 198 additions & 61 deletions tutorials/02_installation.md
View file
Original file line number Diff line number Diff line change
@@ -1,63 +1,89 @@
\page installation Installation

This tutorial describes how to install Ignition Physics on Ubuntu Linux and macOS via either a binary distribution or from source. Support for Windows is coming soon.
These instructions are for installing only Ignition Physics.
If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://ignitionrobotics.org/docs/latest/install).

## Ubuntu
We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible.

The Source Installation instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.

# Ubuntu

## Prerequisites

Ignition Physics uses several c++17 features which are not available in the
version of gcc supplied with Ubuntu Xenial, so Ubuntu Bionic or later
is required.

If you don't already have the `lsb-release` package installed, please do so now:
```{.sh}
```
sudo apt-get update
sudo apt-get install lsb-release
```

Setup your computer to accept software from
[packages.osrfoundation.org](http://packages.osrfoundation.org):

```{.sh}
```
sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
```

Setup keys:

```{.sh}
wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
```

**Install Ignition Physics binaries**

```{.sh}
sudo apt-get update
sudo apt-get install libignition-physics2-dev
wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
```

**Build from source**
## Binary Installation

Run the following to install dependencies
```{.sh}
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y ignition-physics2
On Ubuntu systems, `apt-get` can be used to install `ignition-plugin`:
```

Clone the ign-physics repository from GitHub
```{.sh}
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics2
```

Then build using CMake
```{.sh}
cd ign-physics
mkdir build
cd build
cmake ..
make
sudo make install
sudo apt-get update
sudo apt-get install libignition-physics<#>-dev
```

## macOS
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.

## Source Installation

1. Install dependencies
```
sudo apt-add-repository -s "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -c -s) main"
sudo apt-get build-dep -y ignition-physics<#>-dev
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.

2. Use gcc-8
```
sudo apt update
sudo apt-get -y install g++-8
sudo update-alternatives --install \
/usr/bin/gcc gcc /usr/bin/gcc-8 800 \
--slave /usr/bin/g++ g++ /usr/bin/g++-8 \
--slave /usr/bin/gcov gcov /usr/bin/gcov-8
```

3. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>
```
Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need.

4. Configure and build
```
cd ign-physics
mkdir build
cd build
cmake ..
make
```

5. Optionally, install
```
sudo make install
```

# macOS

## Prerequisites

Ignition Physics and several of its dependencies can be installed on macOS
with [Homebrew](http://brew.sh/) using the [osrf/simulation
Expand All @@ -66,41 +92,152 @@ several c++17 features which are not available in macOS High Sierra (10.13)
and earlier, so macOS Mojave (10.14) with XCode 10.1 are the minimum
system requirements.

**Install Binaries using Homebrew**
## Binary Installation

Install homebrew, which should also prompt you to install the XCode
1. Install Homebrew, which should also prompt you to install the XCode
command-line tools:
```
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```

```{.sh}
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
2. Run the following commands
```
brew tap osrf/simulation
brew install ignition-physics2
```

Run the following commands:
## Source Installation

```{.sh}
brew tap osrf/simulation
brew install ignition-physics2
```
1. Install dependencies
```
brew tap osrf/simulation
brew install ignition-physics2 --only-dependencies
```

**Build from source using Homebrew**
2. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics<#>
```

Run the following to install dependencies
```{.sh}
brew tap osrf/simulation
brew install ignition-physics2 --only-dependencies
```
3. Configure and build
```
cd ign-physics
mkdir build
cd build
cmake ..
make
```

4. Optionally, install
```
sudo make install
```

# Windows

Currently, on Windows, DART is not supported, pending resolution of [dartsim/dart#1522](https://github.com/dartsim/dart/issues/1522) and [conda-forge/dartsim-feedstock#2](https://github.com/conda-forge/dartsim-feedstock/issues/2).
Only [Trivial Physics Engine (TPE)](https://community.gazebosim.org/t/announcing-new-physics-engine-tpe-trivial-physics-engine/629) is supported at the moment.

## Prerequisites

First, follow the [ign-cmake](https://github.com/ignitionrobotics/ign-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment.

Navigate to ``condabin`` if necessary to use the ``conda`` command (i.e., if Conda is not in your `PATH` environment variable. You can find the location of ``condabin`` in Anaconda Prompt, ``where conda``).

Clone the ign-physics repository from GitHub
```{.sh}
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics2
Create if necessary, and activate a Conda environment:
```
conda create -n ign-ws
conda activate ign-ws
```

## Binary Installation

Then build using CMake
```{.sh}
cd ign-physics
mkdir build
cd build
cmake ..
make
sudo make install
```
conda install libignition-physics<#> --channel conda-forge
```

Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
which version you need.

## Source Installation

This assumes you have created and activated a Conda environment while installing the Prerequisites.

1. Install Ignition dependencies:

You can view available versions and their dependencies:
```
conda search libignition-physics* --channel conda-forge --info
```

Install dependencies, replacing `<#>` with the desired versions:
```
conda install libignition-cmake<#> libignition-common<#> libignition-math<#> libignition-plugin<#> libsdformat<#> --channel conda-forge
```

2. Navigate to where you would like to build the library, and clone the repository.
```
# Optionally, append `-b ign-physics#` (replace # with a number) to check out a specific version
git clone https://github.com/ignitionrobotics/ign-physics.git
```

3. Configure and build
```
cd ign-physics
mkdir build
cd build
cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
cmake --build . --config Release
```

4. Optionally, install
```
cmake --install . --config Release
```

# Documentation

API and tutorials can be found at [https://ignitionrobotics.org/libs/physics](https://ignitionrobotics.org/libs/physics).

You can also generate the documentation from a clone of this repository by following these steps.

1. You will need Doxygen. On Ubuntu Doxygen can be installed using
```
sudo apt-get install doxygen
```

2. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-physics -b ign-physics2
```

3. Configure and build the documentation.
```
cd ign-physics
mkdir build
cd build
cmake ..
make doc
```

4. View the documentation by running the following command from the build directory.
```
firefox doxygen/html/index.html
```

# Testing

Follow these steps to run tests and static code analysis in your clone of this repository.

1. Follow the [source install instruction](#source-install).

2. Run tests.
```
make test
```

3. Static code checker.
```
make codecheck
```

0 comments on commit b1876f0

Please sign in to comment.