Skip to content

Commit

Permalink
tutorials/install: Added Windows instructions (#2628)
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Pecka <[email protected]>
  • Loading branch information
peci1 authored Sep 16, 2024
1 parent b32c890 commit 0e1f254
Showing 1 changed file with 72 additions and 3 deletions.
75 changes: 72 additions & 3 deletions tutorials/install.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
\page install Installation

These instructions are for installing only Gazebo. If you're interested
in using all the Gazebo libraries, not only Igniton Gazebo, check out this
These instructions are for installing only Gazebo Sim. If you're interested
in using all the Gazebo libraries including gz-launch, or to install all
libraries from source, check out
[Gazebo installation](https://gazebosim.org/docs/latest/install).

We recommend following the binary install instructions to get up and running as
Expand Down Expand Up @@ -50,6 +51,27 @@ installing Gazebo from source.
brew install gz-sim<#>
```

### Windows

1. First, follow the steps 1-4 of [Gazebo source install](https://gazebosim.org/docs/ionic/install_windows_src/#install-dependencies)
tutorial to install Conda, Visual Studio and set up a Conda environment (we'll call it `gz-ws`).

Do not forget to activate the Conda env (if not already activated)
inside the Visual Studio Command Prompt:

```
conda activate gz-ws
```

2. Now install Gazebo.

```
conda install gz-sim<#> --channel conda-forge
```

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

## Source Install

Install from source if you're interested in changing the source code or need a
Expand Down Expand Up @@ -115,6 +137,50 @@ feature which hasn't been released yet.
sudo make install
```

### Windows

1. First, follow the steps 1-4 of [Gazebo source install](https://gazebosim.org/docs/ionic/install_windows_src/#install-dependencies)
tutorial to install Conda, Visual Studio and set up a Conda environment (we'll call it `gz-ws`).

Do not forget to activate the Conda env (if not already activated)
inside the Visual Studio Command Prompt:

```
conda activate gz-ws
```

2. Install Gazebo dependencies:

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

Install the dependencies, replacing `<#>` with the required versions:
```
conda install gz-cmake<#> gz-common<#> gz-fuel-tools<#> gz-gui<#> gz-math<#> gz-msgs<#> gz-physics<#> gz-plugin<#> gz-rendering<#> gz-sensors<#> gz-tools<#> gz-transport<#> gz-utils<#> sdformat<#> --channel conda-forge
```

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

4. Configure and build
```
cd gz-sim
mkdir build
cd build
cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
cmake --build . --config Release
```

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

## Documentation

API documentation and tutorials can be accessed at [https://gazebosim.org/libs/gazebo](https://gazebosim.org/libs/gazebo)
Expand All @@ -123,7 +189,10 @@ You can also generate the documentation from a clone of this repository by follo

1. You will need [Doxygen](http://www.doxygen.org/). On Ubuntu Doxygen can be installed using
```
# Linux
sudo apt-get install doxygen
# Windows
conda install doxygen --channel conda-forge
```

2. Clone the repository
Expand All @@ -137,7 +206,7 @@ You can also generate the documentation from a clone of this repository by follo
mkdir build
cd build
cmake ../
make doc
cmake --build . --target doc
```

4. View the documentation by running the following command from the `build` directory.
Expand Down

0 comments on commit 0e1f254

Please sign in to comment.