From ee45384e510f058b49ccbdc74610d06584803a9b Mon Sep 17 00:00:00 2001 From: Ian Chen Date: Tue, 12 Sep 2023 17:54:07 +0000 Subject: [PATCH 1/3] Replace ign with gz Signed-off-by: Ian Chen --- tutorials/install.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index 39689286..02aac3fb 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -85,14 +85,14 @@ Gazebo Sensors requires: 1. Clone the repository ``` - git clone https://github.com/gazebosim/gz-sensors -b ign-sensors<#> + git clone https://github.com/gazebosim/gz-sensors -b gz-sensors<#> ``` Be sure to replace `<#>` with a number value, such as 5 or 6, depending on which version you need. 2. Install dependencies ``` - brew install --only-dependencies ignition-sensors<#> + brew install --only-dependencies gz-sensors<#> ``` Be sure to replace `<#>` with a number value, such as 5 or 6, depending on which version you need. @@ -143,7 +143,7 @@ Before [gz-rendering](https://github.com/gazebosim/gz-rendering) becomes availab 2. Navigate to where you would like to build the library, and clone the repository. ``` - # Optionally, append `-b ign-sensors#` (replace # with a number) to check out a specific version + # Optionally, append `-b gz-sensors#` (replace # with a number) to check out a specific version git clone https://github.com/gazebosim/gz-sensors.git ``` @@ -154,9 +154,9 @@ Before [gz-rendering](https://github.com/gazebosim/gz-rendering) becomes availab cd build ``` -4. Before `gz-rendering` becomes available on conda-forge, we need to build it from source and specify the path containing `gz-rendering-config.cmake` in `CMAKE_PREFIX_PATH`, for cmake to find `gz-rendering`. That path could be `gz-rendering-install-path\lib\cmake\gz-rendering4`, for example. +4. Before `gz-rendering` becomes available on conda-forge, we need to build it from source and specify the path containing `gz-rendering-config.cmake` in `CMAKE_PREFIX_PATH`, for cmake to find `gz-rendering`. That path could be `gz-rendering-install-path\lib\cmake\gz-rendering8`, for example. ``` - cmake .. -DBUILD_TESTING=OFF -DCMAKE_PREFIX_PATH=path\containing\ignition-rendering-config # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install + cmake .. -DBUILD_TESTING=OFF -DCMAKE_PREFIX_PATH=path\containing\gz-rendering-config # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install cmake --build . --config Release ``` From f9751335bd34ae46768a3919dc52c3eabc1942fa Mon Sep 17 00:00:00 2001 From: Ian Chen Date: Wed, 13 Sep 2023 20:18:25 +0000 Subject: [PATCH 2/3] update windows installation instructions Signed-off-by: Ian Chen --- tutorials/install.md | 59 ++++++++++++++++++++++---------------------- 1 file changed, 30 insertions(+), 29 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index 02aac3fb..bff07da7 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -40,7 +40,27 @@ which version you need. ### Windows -Binary install is pending `gz-rendering` and `gz-sensors` being added to conda-forge. +#### Install Prerequisites + +First, follow the [gz-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and 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`). + +Create if necessary, and activate a Conda environment: + +``` +conda create -n gz-ws +conda activate gz-ws +``` + +#### Binary Installation + +``` +conda install libgz-sensors<#> --channel conda-forge +``` + +Be sure to replace `<#>` with a number value, such as 7 or 8, depending on +which version you need. ## Source Install @@ -113,32 +133,19 @@ Gazebo Sensors requires: ### Windows -#### Install Prerequisites - -First, follow the [gz-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and 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`). - -Create if necessary, and activate a Conda environment: +This assumes you have created and activated a Conda environment while [installing the Prerequisites](#install-prerequisites). -``` -conda create -n gz-ws -conda activate gz-ws -``` +1. Install Gazebo dependencies: -Install Gazebo dependencies, replacing `<#>` with the desired versions: - -``` -conda install libgz-cmake<#> libgz-common<#> libgz-math<#> libgz-transport<#> libgz-msgs<#> --channel conda-forge -``` - -Before [gz-rendering](https://github.com/gazebosim/gz-rendering) becomes available on conda-forge, follow its tutorial to build it from source. + You can view available versions and their dependencies: + ``` + conda search libgz-sensors* --channel conda-forge --info + ``` -#### Build from source + Install dependencies, replacing `<#>` with the desired versions: -1. Activate the Conda environment created in the prerequisites: ``` - conda activate gz-ws + conda install libgz-cmake<#> libgz-common<#> libgz-math<#> libgz-transport<#> libgz-msgs<#> libgz-rendering<#> --channel conda-forge ``` 2. Navigate to where you would like to build the library, and clone the repository. @@ -154,13 +161,7 @@ Before [gz-rendering](https://github.com/gazebosim/gz-rendering) becomes availab cd build ``` -4. Before `gz-rendering` becomes available on conda-forge, we need to build it from source and specify the path containing `gz-rendering-config.cmake` in `CMAKE_PREFIX_PATH`, for cmake to find `gz-rendering`. That path could be `gz-rendering-install-path\lib\cmake\gz-rendering8`, for example. - ``` - cmake .. -DBUILD_TESTING=OFF -DCMAKE_PREFIX_PATH=path\containing\gz-rendering-config # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install - cmake --build . --config Release - ``` - -5. Optionally, install. You will likely need to run a terminal with admin privileges for this call to succeed. +4. Optionally, install. You will likely need to run a terminal with admin privileges for this call to succeed. ``` cmake --install . --config Release ``` From 610092b4eece570411cf832516c2e5cedd343c20 Mon Sep 17 00:00:00 2001 From: Ian Chen Date: Wed, 13 Sep 2023 20:21:25 +0000 Subject: [PATCH 3/3] consistening version numbering Signed-off-by: Ian Chen --- tutorials/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/install.md b/tutorials/install.md index bff07da7..6c58d59b 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -18,7 +18,7 @@ sudo apt-get update 2. Install Gazebo Sensors ```{.sh} -# Change <#> to a version number, like 3 or 4 +# Change <#> to a version number, like 7 or 8 sudo apt install libgz-sensors<#>-dev ``` @@ -35,7 +35,7 @@ sudo apt install libgz-sensors<#>-dev brew install gz-sensors<#> ``` -Be sure to replace `<#>` with a number value, such as 5 or 6, depending on +Be sure to replace `<#>` with a number value, such as 7 or 8, depending on which version you need. ### Windows