From ce5d3e8e6c50bd180d33cc653ab560b68d670cf3 Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Tue, 5 Jan 2021 18:27:34 -0800 Subject: [PATCH 1/7] add windows citadel build Signed-off-by: John Shepherd --- citadel/install.md | 20 ++--- citadel/install_windows.md | 65 ++++++++++++++++ citadel/install_windows_src.md | 135 +++++++++++++++++++++++++++++++++ 3 files changed, 210 insertions(+), 10 deletions(-) create mode 100644 citadel/install_windows.md create mode 100644 citadel/install_windows_src.md diff --git a/citadel/install.md b/citadel/install.md index c0c97aa57..b052d0b37 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -7,26 +7,26 @@ Citadel supports the following platforms: * Ignition currently only works in headless mode (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only). - -Windows support is still experimental although most of the packages should work -as expected. There are no binaries for Windows at this time. The `ign-gazebo` -package is still not available for Windows; the installation should be done from -source code. The [Source Installation on Ubuntu Bionic](install_ubuntu_src) -contains some tips for Windows. + * Windows 10 + * Ignition command line utilities do not work. + * All packages up to but not including `ign-gazebo` are currently supported. + * DART physics engine is not yet supported. ## Binary installation instructions Binary installation is the recommended method of installing Ignition. - * [Binary Installation on Ubuntu Bionic](install_ubuntu) - * [Binary Installation on MacOS Mojave (10.14)](install_osx) + * [Binary Installation on Ubuntu Bionic](install_ubuntu.md) + * [Binary Installation on MacOS Mojave (10.14)](install_osx.md) + * [Binary Installation on Windows 10](install_windows.md) ## Source Installation instructions Source installation is recommended for users planning on altering Ignition's source code (advanced). - * [Source Installation on Ubuntu Bionic](install_ubuntu_src) - * [Source Installation on MacOS](install_osx_src) + * [Source Installation on Ubuntu Bionic](install_ubuntu_src.md) + * [Source Installation on MacOS](install_osx_src.md) + * [Source Installation on Windows](install_windows_src.md) ## Citadel Libraries diff --git a/citadel/install_windows.md b/citadel/install_windows.md new file mode 100644 index 000000000..a028a7156 --- /dev/null +++ b/citadel/install_windows.md @@ -0,0 +1,65 @@ +# Binary Installation on Windows 10 + +Only the following Ignition packages are currently available on `conda-forge`, +the package manager Ignition uses for Windows binary installations: +- `ign-common` +- `ign-msgs` +- `ign-math` +- `ign-cmake` +- `ign-fuel-tools` +- `ign-transport` +- `ign-tools` +- `ign-physics` +- `ign-plugin` + +The remaining packages currently have an [outstanding ticket](https://github.com/conda-forge/staged-recipes/issues/13551), +and will not be supported until they are added to the `conda-forge` feedstock. + +Additionally, command line tools as well as the DART physics engine are not currently supported in Windows. + +The above mentioned Ignition packages are available in Windows 10 using the [conda-forge package manager](https://conda-forge.org/), +and the Ignition feedstock recipes can be found [here](https://github.com/conda-forge?q=libignition&type=&language=). + +In order to use `conda-forge`, you will need to +1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. +2. Open a Windows command prompt, being sure to have `conda` added to your Windows `PATH` system environment variable (you may also need to open a new command prompt to see any `PATH` changes reflected). +3. Create and activate a new Conda environment: +```bash +conda create -n ign-ws +conda activate ign-ws +``` +4. Install desired Ignition packages, since all of Ignition isn't currently supported, you will need to choose which package(s) +you want to install based on your application. +```bash +conda install libignition-<#> --channel conda-forge +``` +Be sure to replace `` with your desired package name (ie, common, msgs, etc.) and `<#>` with the release version. If left unspecified, `conda-forge` will install the most recently stable release packages. Be sure to check the [high level install instructions](install) for corresponding version numbers. + +**Note** + +You can view all available versions of a specific package with: +```bash +conda search libignition-* --channel conda-forge +``` +and view their dependencies with +```bash +conda search libignition-* --channel conda-forge --info +``` +and install a specific minor version with +```bash +conda install libignition-=.. --channel conda-forge +``` +where `` is the major release number, `` is the minor release number, and ` --channel conda-forge +``` + +## Troubleshooting + +See [Troubleshooting](troubleshooting) diff --git a/citadel/install_windows_src.md b/citadel/install_windows_src.md new file mode 100644 index 000000000..4a35e38bd --- /dev/null +++ b/citadel/install_windows_src.md @@ -0,0 +1,135 @@ +# Source Installation on Windows 10 + +Currently, `ign-gazebo` and `ign-launch` are not supported on Windows 10 + +Additionally, command line tools as well as the DART physics engine are not currently supported in Windows. + +## Install dependencies + +1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. +1. Install [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). The Community version is free for students, open-source developers, and personal development. Check "Desktop development with C++" in the Workloads tab, and uncheck "C++ Cmake Tools." We will install cmake via Conda. +1. Open a Visual Studio Command Prompt (search for "x64 Native Tools Command Prompt for VS 2019" in the Windows search field near the Windows button). Optionally, right-click and pin to the task bar for quick access in the future. + + If you did not add Conda to your `PATH` environment variable during Conda installation, you may need to navigate to the location of `condabin` in order to use the `conda` command. + To find `condabin`, search for "Anaconda Prompt" in the Windows search field near the Windows button, open it, run `where conda`, and look for a line containing the directory `condabin`. + +1. Navigate to your `condabin`, if necessary, and then create and activate a Conda environment: + + conda create -n ign-ws + conda activate ign-ws + + Once you have activate an environment, a prefix like `(ign-ws)` will be prepended to your prompt, and you can use the `conda` command outside of the `condabin` directory. + + You can use `conda info --envs` to see all of your environments. + + To remove an environment, use `conda env remove --name `. + +1. Install dependencies + + conda install cmake git vcstool curl pkg-config \ + colcon-common-extensions eigen freeimage gts \ + glib dlfcn-win32 ffmpeg ruby tinyxml2 tinyxml \ + protobuf urdfdom zeromq cppzmq ogre jsoncpp \ + libzip qt --channel conda-forge + +1. Navigate to where you would like to build the library, and then clone the repositories. + + curl -O https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-citadel.yaml` + mkdir src + vcs import src < collection-citadel.yaml + +1. Install `ign-cmake` from `conda-forge` and disable the cloned `ign-cmake` from being built. + + conda install libignition-cmake2 + touch src/ign-cmake/COLCON_IGNORE + + This is due to a linking error currently existing within the `ign-cmake` source. See the comments [here](https://github.com/ignitionrobotics/docs/issues/96#issuecomment-742096017). + +**Note** + +You can view all available versions of a specific package with: +```bash +conda search libignition-* --channel conda-forge +``` +and view their dependencies with +```bash +conda search libignition-* --channel conda-forge --info +``` +and install a specific minor version with +```bash +conda install libignition-=.. --channel conda-forge +``` +where `` is the major release number, `` is the minor release number, and ` Date: Tue, 5 Jan 2021 18:31:07 -0800 Subject: [PATCH 2/7] Remove windows notes Signed-off-by: John Shepherd --- citadel/install_ubuntu_src.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/citadel/install_ubuntu_src.md b/citadel/install_ubuntu_src.md index 92e991cb9..05e824d75 100644 --- a/citadel/install_ubuntu_src.md +++ b/citadel/install_ubuntu_src.md @@ -54,9 +54,6 @@ sudo apt-get install git ## Getting the sources -The instructions below use some UNIX commands to manage directories but the -equivalent alternatives on Windows should provide the same result. - The first step is to create a developer workspace in which `vcstool` and `colcon` can work: @@ -172,7 +169,6 @@ sudo apt-get install -y \ ### Install compiler requirements The Ignition Libraries require the gcc compiler version 8 or higher. -(Windows requires Visual Studio 2019). #### Ubuntu Bionic From 2690dd9134d02c71684a8d434867cee27d83628c Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Thu, 7 Jan 2021 12:19:16 -0800 Subject: [PATCH 3/7] Minor fixes Signed-off-by: John Shepherd --- citadel/install.md | 4 ++-- citadel/install_windows.md | 10 +++++++++- citadel/install_windows_src.md | 21 +++++++++++---------- 3 files changed, 22 insertions(+), 13 deletions(-) diff --git a/citadel/install.md b/citadel/install.md index b052d0b37..504297d79 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -8,7 +8,7 @@ Citadel supports the following platforms: (GUI does not render; instead of using `ign gazebo fuel.sdf` command, use `ign gazebo -s fuel.sdf` to start the server only). * Windows 10 - * Ignition command line utilities do not work. + * Ignition command line utilities are not yet supported. * All packages up to but not including `ign-gazebo` are currently supported. * DART physics engine is not yet supported. @@ -26,7 +26,7 @@ Source installation is recommended for users planning on altering Ignition's sou * [Source Installation on Ubuntu Bionic](install_ubuntu_src.md) * [Source Installation on MacOS](install_osx_src.md) - * [Source Installation on Windows](install_windows_src.md) + * [Source Installation on Windows 10](install_windows_src.md) ## Citadel Libraries diff --git a/citadel/install_windows.md b/citadel/install_windows.md index a028a7156..255d16f6e 100644 --- a/citadel/install_windows.md +++ b/citadel/install_windows.md @@ -15,7 +15,7 @@ the package manager Ignition uses for Windows binary installations: The remaining packages currently have an [outstanding ticket](https://github.com/conda-forge/staged-recipes/issues/13551), and will not be supported until they are added to the `conda-forge` feedstock. -Additionally, command line tools as well as the DART physics engine are not currently supported in Windows. +Additionally, command line tools, the DART physics engine, and tests are not currently supported in Windows. The above mentioned Ignition packages are available in Windows 10 using the [conda-forge package manager](https://conda-forge.org/), and the Ignition feedstock recipes can be found [here](https://github.com/conda-forge?q=libignition&type=&language=). @@ -23,6 +23,14 @@ and the Ignition feedstock recipes can be found [here](https://github.com/conda- In order to use `conda-forge`, you will need to 1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. 2. Open a Windows command prompt, being sure to have `conda` added to your Windows `PATH` system environment variable (you may also need to open a new command prompt to see any `PATH` changes reflected). + + If you did not add Conda to your `PATH` environment variable + during Conda installation, you may need to navigate to the + location of `condabin` in order to use the `conda` command. + To find `condabin`, search for "Anaconda Prompt" in the + Windows search field near the Windows button, open it, run + `where conda`, and look for a line containing the directory `condabin`. + 3. Create and activate a new Conda environment: ```bash conda create -n ign-ws diff --git a/citadel/install_windows_src.md b/citadel/install_windows_src.md index 4a35e38bd..2b00da3b6 100644 --- a/citadel/install_windows_src.md +++ b/citadel/install_windows_src.md @@ -26,22 +26,22 @@ Additionally, command line tools as well as the DART physics engine are not curr 1. Install dependencies - conda install cmake git vcstool curl pkg-config \ - colcon-common-extensions eigen freeimage gts \ - glib dlfcn-win32 ffmpeg ruby tinyxml2 tinyxml \ - protobuf urdfdom zeromq cppzmq ogre jsoncpp \ + conda install cmake git vcstool curl pkg-config ^ + colcon-common-extensions eigen freeimage gts ^ + glib dlfcn-win32 ffmpeg ruby tinyxml2 tinyxml ^ + protobuf urdfdom zeromq cppzmq ogre jsoncpp ^ libzip qt --channel conda-forge 1. Navigate to where you would like to build the library, and then clone the repositories. - curl -O https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-citadel.yaml` + curl -O https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-citadel.yaml mkdir src vcs import src < collection-citadel.yaml 1. Install `ign-cmake` from `conda-forge` and disable the cloned `ign-cmake` from being built. - conda install libignition-cmake2 - touch src/ign-cmake/COLCON_IGNORE + conda install libignition-cmake2 --channel conda-forge + touch src\ign-cmake\COLCON_IGNORE This is due to a linking error currently existing within the `ign-cmake` source. See the comments [here](https://github.com/ignitionrobotics/docs/issues/96#issuecomment-742096017). @@ -68,7 +68,6 @@ Start the procedure by changing into the workspace and listing the packages recognized by `colcon`: ```bash -cd ~/workspace/ colcon graph ``` @@ -80,6 +79,7 @@ to build the whole set of libraries: ```bash colcon build --cmake-args -DBUILD_TESTING=OFF --merge-install --packages-up-to ignition-gazebo3 ``` +Tests are turned off as they are not currently supported on Windows. To build a specific package with all its dependent packages: @@ -121,10 +121,11 @@ the results you want: there is no Ignition install on your system. 2. If, in addition to not wanting to use the libraries, you're also trying to - free up space, you can delete the entire workspace directory with: + free up space, you can delete the entire workspace directory from within + your `conda` environment with: ```bash - rm -rf ~/workspace + rm -rf ``` 3. If you want to keep the source code, you can remove the From acde48bd85bd4d290646d0c653f4fd7af2c800db Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Thu, 7 Jan 2021 12:33:51 -0800 Subject: [PATCH 4/7] fixes Signed-off-by: John Shepherd --- citadel/install.md | 1 + 1 file changed, 1 insertion(+) diff --git a/citadel/install.md b/citadel/install.md index 504297d79..b5cac2445 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -11,6 +11,7 @@ Citadel supports the following platforms: * Ignition command line utilities are not yet supported. * All packages up to but not including `ign-gazebo` are currently supported. * DART physics engine is not yet supported. + * Qt is not yet supported. ## Binary installation instructions From 72f9eba4f94965dd2bfc9b3a1b778344953a5594 Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Fri, 15 Jan 2021 14:54:10 -0800 Subject: [PATCH 5/7] suggested fixes Signed-off-by: John Shepherd --- citadel/install.md | 4 +- citadel/install_windows.md | 37 ++++++++-------- citadel/install_windows_src.md | 81 ++++++++++++++++++++-------------- 3 files changed, 68 insertions(+), 54 deletions(-) diff --git a/citadel/install.md b/citadel/install.md index b5cac2445..4d30f51f8 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -9,9 +9,9 @@ Citadel supports the following platforms: `ign gazebo -s fuel.sdf` to start the server only). * Windows 10 * Ignition command line utilities are not yet supported. - * All packages up to but not including `ign-gazebo` are currently supported. + * All packages up to but not including `ign-gazebo` are currently building. * DART physics engine is not yet supported. - * Qt is not yet supported. + * Qt (GUI functionality) is not yet supported. ## Binary installation instructions diff --git a/citadel/install_windows.md b/citadel/install_windows.md index 255d16f6e..d32f62355 100644 --- a/citadel/install_windows.md +++ b/citadel/install_windows.md @@ -12,36 +12,37 @@ the package manager Ignition uses for Windows binary installations: - `ign-physics` - `ign-plugin` +The above mentioned Ignition packages are available in Windows 10 using the [conda-forge package manager](https://conda-forge.org/), +and the Ignition feedstock recipes can be found [here](https://github.com/conda-forge?q=libignition&type=&language=). + The remaining packages currently have an [outstanding ticket](https://github.com/conda-forge/staged-recipes/issues/13551), and will not be supported until they are added to the `conda-forge` feedstock. Additionally, command line tools, the DART physics engine, and tests are not currently supported in Windows. -The above mentioned Ignition packages are available in Windows 10 using the [conda-forge package manager](https://conda-forge.org/), -and the Ignition feedstock recipes can be found [here](https://github.com/conda-forge?q=libignition&type=&language=). - In order to use `conda-forge`, you will need to -1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. +1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. You will likely want to check the box to add `conda` to your `PATH` during the installation process so that you won't have to do this step manually. + 2. Open a Windows command prompt, being sure to have `conda` added to your Windows `PATH` system environment variable (you may also need to open a new command prompt to see any `PATH` changes reflected). - If you did not add Conda to your `PATH` environment variable - during Conda installation, you may need to navigate to the - location of `condabin` in order to use the `conda` command. - To find `condabin`, search for "Anaconda Prompt" in the - Windows search field near the Windows button, open it, run - `where conda`, and look for a line containing the directory `condabin`. + If you did not add Conda to your `PATH` environment variable + during Conda installation, you may need to navigate to the + location of `condabin` in order to use the `conda` command. + To find `condabin`, search for "Anaconda Prompt" in the + Windows search field near the Windows button, open it, run + `where conda`, and look for a line containing the directory `condabin`. 3. Create and activate a new Conda environment: -```bash -conda create -n ign-ws -conda activate ign-ws -``` + ```bash + conda create -n ign-ws + conda activate ign-ws + ``` 4. Install desired Ignition packages, since all of Ignition isn't currently supported, you will need to choose which package(s) you want to install based on your application. -```bash -conda install libignition-<#> --channel conda-forge -``` -Be sure to replace `` with your desired package name (ie, common, msgs, etc.) and `<#>` with the release version. If left unspecified, `conda-forge` will install the most recently stable release packages. Be sure to check the [high level install instructions](install) for corresponding version numbers. + ```bash + conda install libignition-<#> --channel conda-forge + ``` + Be sure to replace `` with your desired package name (ie, common, msgs, etc.) and `<#>` with the release version. If left unspecified, `conda-forge` will install the most recently stable release packages. Be sure to check the [high level install instructions](install) for corresponding version numbers. **Note** diff --git a/citadel/install_windows_src.md b/citadel/install_windows_src.md index 2b00da3b6..5b0a92776 100644 --- a/citadel/install_windows_src.md +++ b/citadel/install_windows_src.md @@ -1,49 +1,62 @@ # Source Installation on Windows 10 -Currently, `ign-gazebo` and `ign-launch` are not supported on Windows 10 +Currently, `ign-gazebo` and `ign-launch` are not supported on Windows 10. -Additionally, command line tools as well as the DART physics engine are not currently supported in Windows. +Additionally, command line tools, DART physics engine, and gui capabilities are not currently supported in Windows. These functionalities correspond to the currently building packages `ign-tools`, `ign-physics`, and `ign-gui`, respectively. -## Install dependencies +**Note** -1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. -1. Install [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). The Community version is free for students, open-source developers, and personal development. Check "Desktop development with C++" in the Workloads tab, and uncheck "C++ Cmake Tools." We will install cmake via Conda. -1. Open a Visual Studio Command Prompt (search for "x64 Native Tools Command Prompt for VS 2019" in the Windows search field near the Windows button). Optionally, right-click and pin to the task bar for quick access in the future. +You will still be able to use `TPE` as a physics engine (see [here](https://ignitionrobotics.org/api/physics/2.2/physicsplugin.html) for more information on `TPE`). - If you did not add Conda to your `PATH` environment variable during Conda installation, you may need to navigate to the location of `condabin` in order to use the `conda` command. - To find `condabin`, search for "Anaconda Prompt" in the Windows search field near the Windows button, open it, run `where conda`, and look for a line containing the directory `condabin`. +## Install dependencies -1. Navigate to your `condabin`, if necessary, and then create and activate a Conda environment: +1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. You will likely want to check the box to add `conda` to your `PATH` during the installation process so that you won't have to do this step manually. - conda create -n ign-ws - conda activate ign-ws +2. Install [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). The Community version is free for students, open-source developers, and personal development. Check "Desktop development with C++" in the Workloads tab, and uncheck "C++ Cmake Tools." We will install cmake via Conda. - Once you have activate an environment, a prefix like `(ign-ws)` will be prepended to your prompt, and you can use the `conda` command outside of the `condabin` directory. +3. Open a Visual Studio Command Prompt (search for "x64 Native Tools Command Prompt for VS 2019" in the Windows search field near the Windows button). Optionally, right-click and pin to the task bar for quick access in the future. - You can use `conda info --envs` to see all of your environments. + If you did not add Conda to your `PATH` environment variable during Conda installation, you may need to navigate to the location of `condabin` in order to use the `conda` command. + To find `condabin`, search for "Anaconda Prompt" in the Windows search field near the Windows button, open it, run `where conda`, and look for a line containing the directory `condabin`. - To remove an environment, use `conda env remove --name `. +4. Navigate to your `condabin`, if necessary, and then create and activate a Conda environment: + ```bash + conda create -n ign-ws + conda activate ign-ws + ``` -1. Install dependencies + Once you have activate an environment, a prefix like `(ign-ws)` will be prepended to your prompt, and you can use the `conda` command outside of the `condabin` directory. - conda install cmake git vcstool curl pkg-config ^ - colcon-common-extensions eigen freeimage gts ^ - glib dlfcn-win32 ffmpeg ruby tinyxml2 tinyxml ^ - protobuf urdfdom zeromq cppzmq ogre jsoncpp ^ - libzip qt --channel conda-forge + You can use `conda info --envs` to see all of your environments. -1. Navigate to where you would like to build the library, and then clone the repositories. + To remove an environment, use `conda env remove --name `. - curl -O https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-citadel.yaml - mkdir src - vcs import src < collection-citadel.yaml +5. Install dependencies: -1. Install `ign-cmake` from `conda-forge` and disable the cloned `ign-cmake` from being built. + ```bash + conda install cmake git vcstool curl pkg-config ^ + colcon-common-extensions eigen freeimage gts ^ + glib dlfcn-win32 ffmpeg ruby tinyxml2 tinyxml ^ + protobuf urdfdom zeromq cppzmq ogre jsoncpp ^ + libzip qt --channel conda-forge + ``` - conda install libignition-cmake2 --channel conda-forge - touch src\ign-cmake\COLCON_IGNORE +6. Navigate to where you would like to build the library, create and enter your workspace directory, create the `src` directory which will contain the Ignition source code, and then clone the repositories. + ```bash + mkdir ign-ws + cd ign-ws + curl -O https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-citadel.yaml + mkdir src + vcs import src < collection-citadel.yaml + ``` - This is due to a linking error currently existing within the `ign-cmake` source. See the comments [here](https://github.com/ignitionrobotics/docs/issues/96#issuecomment-742096017). +7. Install `ign-cmake` from `conda-forge` and disable the cloned `ign-cmake` from being built. + ```bash + conda install libignition-cmake2 --channel conda-forge + touch src\ign-cmake\COLCON_IGNORE + ``` + + This is due to a linking error currently existing within the `ign-cmake` source. See the comments [here](https://github.com/ignitionrobotics/docs/issues/96#issuecomment-742096017). **Note** @@ -71,16 +84,16 @@ recognized by `colcon`: colcon graph ``` -`colcon graph` should list the Ignition libraries with an -[interdependency diagram](https://colcon.readthedocs.io/en/released/reference/verb/graph.html#example-output). -If that is the case, then you are ready -to build the whole set of libraries: +`colcon graph` should list the Ignition libraries with an [interdependency diagram](https://colcon.readthedocs.io/en/released/reference/verb/graph.html#example-output). +If that is the case, then you are ready to build the whole set of libraries: ```bash colcon build --cmake-args -DBUILD_TESTING=OFF --merge-install --packages-up-to ignition-gazebo3 ``` Tests are turned off as they are not currently supported on Windows. +**Note:** All of the Ignition packages up to, but not including `ign-gazebo` are currently building. The above command should successfully build all packages except for `ign-gazebo`. + To build a specific package with all its dependent packages: ```bash @@ -107,7 +120,7 @@ Run the following command to source the workspace: call install\setup.bat ``` -This is the end of the source install instructions; head back to the [Getting started](getting_started.html) +This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted) page to start using Ignition! ## Uninstalling source-based install @@ -117,7 +130,7 @@ the results you want: 1. If you installed your workspace with `colcon` as instructed above, "uninstalling" could be just a matter of opening a new terminal and not sourcing the - workspace's `setup.sh`. This way, your environment will behave as though + workspace's `setup.bat`. This way, your environment will behave as though there is no Ignition install on your system. 2. If, in addition to not wanting to use the libraries, you're also trying to From 6e4b3986e8997d560d63b215ba578e4a2a173bd0 Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Fri, 15 Jan 2021 15:16:23 -0800 Subject: [PATCH 6/7] Spacing and phrasing Signed-off-by: John Shepherd --- citadel/install_windows.md | 13 +++++++--- citadel/install_windows_src.md | 43 ++++++++++++++++++++++++---------- 2 files changed, 40 insertions(+), 16 deletions(-) diff --git a/citadel/install_windows.md b/citadel/install_windows.md index d32f62355..4c1e25e3e 100644 --- a/citadel/install_windows.md +++ b/citadel/install_windows.md @@ -21,9 +21,13 @@ and will not be supported until they are added to the `conda-forge` feedstock. Additionally, command line tools, the DART physics engine, and tests are not currently supported in Windows. In order to use `conda-forge`, you will need to -1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. You will likely want to check the box to add `conda` to your `PATH` during the installation process so that you won't have to do this step manually. +1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). + Miniconda suffices. You will likely want to check the box to add `conda` to your `PATH` + during the installation process so that you won't have to do this step manually. -2. Open a Windows command prompt, being sure to have `conda` added to your Windows `PATH` system environment variable (you may also need to open a new command prompt to see any `PATH` changes reflected). +2. Open a Windows command prompt, being sure to have `conda` added to your + Windows `PATH` system environment variable (you may also need to open + a new command prompt to see any `PATH` changes reflected). If you did not add Conda to your `PATH` environment variable during Conda installation, you may need to navigate to the @@ -42,7 +46,10 @@ you want to install based on your application. ```bash conda install libignition-<#> --channel conda-forge ``` - Be sure to replace `` with your desired package name (ie, common, msgs, etc.) and `<#>` with the release version. If left unspecified, `conda-forge` will install the most recently stable release packages. Be sure to check the [high level install instructions](install) for corresponding version numbers. + Be sure to replace `` with your desired package name (ie, common, msgs, etc.) + and `<#>` with the release version. If left unspecified, `conda-forge` will install the + most recently stable release packages. Be sure to check the + [high level install instructions](install) for corresponding version numbers. **Note** diff --git a/citadel/install_windows_src.md b/citadel/install_windows_src.md index 5b0a92776..7cb2ff7b0 100644 --- a/citadel/install_windows_src.md +++ b/citadel/install_windows_src.md @@ -2,22 +2,34 @@ Currently, `ign-gazebo` and `ign-launch` are not supported on Windows 10. -Additionally, command line tools, DART physics engine, and gui capabilities are not currently supported in Windows. These functionalities correspond to the currently building packages `ign-tools`, `ign-physics`, and `ign-gui`, respectively. +Additionally, command line tools, DART physics engine, and gui capabilities are +not currently supported in Windows. These functionalities correspond to the currently +building packages `ign-tools`, `ign-physics`, and `ign-gui`, respectively. **Note** -You will still be able to use `TPE` as a physics engine (see [here](https://ignitionrobotics.org/api/physics/2.2/physicsplugin.html) for more information on `TPE`). +You will still be able to use `TPE` as a physics engine +(see [here](https://ignitionrobotics.org/api/physics/2.2/physicsplugin.html) for more information on `TPE`). ## Install dependencies -1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). Miniconda suffices. You will likely want to check the box to add `conda` to your `PATH` during the installation process so that you won't have to do this step manually. +1. Install a [Conda package management system](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html). + Miniconda suffices. You will likely want to check the box to add `conda` to your `PATH` + during the installation process so that you won't have to do this step manually. -2. Install [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). The Community version is free for students, open-source developers, and personal development. Check "Desktop development with C++" in the Workloads tab, and uncheck "C++ Cmake Tools." We will install cmake via Conda. +2. Install [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). + The Community version is free for students, open-source developers, and personal + development. Check "Desktop development with C++" in the Workloads tab, + and uncheck "C++ Cmake Tools." We will install cmake via Conda. -3. Open a Visual Studio Command Prompt (search for "x64 Native Tools Command Prompt for VS 2019" in the Windows search field near the Windows button). Optionally, right-click and pin to the task bar for quick access in the future. +3. Open a Visual Studio Command Prompt (search for "x64 Native Tools Command Prompt + for VS 2019" in the Windows search field near the Windows button). Optionally, + right-click and pin to the task bar for quick access in the future. - If you did not add Conda to your `PATH` environment variable during Conda installation, you may need to navigate to the location of `condabin` in order to use the `conda` command. - To find `condabin`, search for "Anaconda Prompt" in the Windows search field near the Windows button, open it, run `where conda`, and look for a line containing the directory `condabin`. + If you did not add Conda to your `PATH` environment variable during Conda installation, + you may need to navigate to the location of `condabin` in order to use the `conda` command. + To find `condabin`, search for "Anaconda Prompt" in the Windows search field near the + Windows button, open it, run `where conda`, and look for a line containing the directory `condabin`. 4. Navigate to your `condabin`, if necessary, and then create and activate a Conda environment: ```bash @@ -25,7 +37,8 @@ You will still be able to use `TPE` as a physics engine (see [here](https://igni conda activate ign-ws ``` - Once you have activate an environment, a prefix like `(ign-ws)` will be prepended to your prompt, and you can use the `conda` command outside of the `condabin` directory. + Once you have activate an environment, a prefix like `(ign-ws)` will be prepended to + your prompt, and you can use the `conda` command outside of the `condabin` directory. You can use `conda info --envs` to see all of your environments. @@ -41,7 +54,8 @@ You will still be able to use `TPE` as a physics engine (see [here](https://igni libzip qt --channel conda-forge ``` -6. Navigate to where you would like to build the library, create and enter your workspace directory, create the `src` directory which will contain the Ignition source code, and then clone the repositories. +6. Navigate to where you would like to build the library, create and enter your workspace directory, + create the `src` directory which will contain the Ignition source code, and then clone the repositories. ```bash mkdir ign-ws cd ign-ws @@ -56,7 +70,8 @@ You will still be able to use `TPE` as a physics engine (see [here](https://igni touch src\ign-cmake\COLCON_IGNORE ``` - This is due to a linking error currently existing within the `ign-cmake` source. See the comments [here](https://github.com/ignitionrobotics/docs/issues/96#issuecomment-742096017). + This is due to a linking error currently existing within the `ign-cmake` source. + See the comments [here](https://github.com/ignitionrobotics/docs/issues/96#issuecomment-742096017). **Note** @@ -77,14 +92,15 @@ where `` is the major release number, `` is the minor release numb ## Building the Ignition Libraries Once the compiler and all the sources are in place it is time to compile them. -Start the procedure by changing into the workspace and listing the packages +Start the procedure by navigating to your workspace and listing the packages recognized by `colcon`: ```bash colcon graph ``` -`colcon graph` should list the Ignition libraries with an [interdependency diagram](https://colcon.readthedocs.io/en/released/reference/verb/graph.html#example-output). +`colcon graph` should list the Ignition libraries with an +[interdependency diagram](https://colcon.readthedocs.io/en/released/reference/verb/graph.html#example-output). If that is the case, then you are ready to build the whole set of libraries: ```bash @@ -92,7 +108,8 @@ colcon build --cmake-args -DBUILD_TESTING=OFF --merge-install --packages-up-to i ``` Tests are turned off as they are not currently supported on Windows. -**Note:** All of the Ignition packages up to, but not including `ign-gazebo` are currently building. The above command should successfully build all packages except for `ign-gazebo`. +**Note:** All of the Ignition packages up to, but not including `ign-gazebo` +are currently building. The above command should successfully build all packages except for `ign-gazebo`. To build a specific package with all its dependent packages: From 361889642f3dbb26883ef21e63636b357753d8a9 Mon Sep 17 00:00:00 2001 From: John Shepherd Date: Wed, 20 Jan 2021 17:50:00 -0800 Subject: [PATCH 7/7] nits Signed-off-by: John Shepherd --- citadel/install.md | 4 ++-- citadel/install_windows_src.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/citadel/install.md b/citadel/install.md index 930f8aa6f..d1572a239 100644 --- a/citadel/install.md +++ b/citadel/install.md @@ -18,7 +18,7 @@ Citadel supports the following platforms: Binary installation is the recommended method of installing Ignition. - * [Binary Installation on Ubuntu Bionic](install_ubuntu.md) + * [Binary Installation on Ubuntu](install_ubuntu.md) * [Binary Installation on MacOS Mojave (10.14)](install_osx.md) * [Binary Installation on Windows 10](install_windows.md) @@ -26,7 +26,7 @@ Binary installation is the recommended method of installing Ignition. Source installation is recommended for users planning on altering Ignition's source code (advanced). - * [Source Installation on Ubuntu Bionic](install_ubuntu_src.md) + * [Source Installation on Ubuntu](install_ubuntu_src.md) * [Source Installation on MacOS](install_osx_src.md) * [Source Installation on Windows 10](install_windows_src.md) diff --git a/citadel/install_windows_src.md b/citadel/install_windows_src.md index 7cb2ff7b0..3f4de6f28 100644 --- a/citadel/install_windows_src.md +++ b/citadel/install_windows_src.md @@ -2,7 +2,7 @@ Currently, `ign-gazebo` and `ign-launch` are not supported on Windows 10. -Additionally, command line tools, DART physics engine, and gui capabilities are +Additionally, command line tools, DART physics engine, and GUI capabilities are not currently supported in Windows. These functionalities correspond to the currently building packages `ign-tools`, `ign-physics`, and `ign-gui`, respectively.