Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gz-utils: Installation #945

Closed
2 tasks done
Voldivh opened this issue Sep 11, 2023 · 6 comments
Closed
2 tasks done

gz-utils: Installation #945

Voldivh opened this issue Sep 11, 2023 · 6 comments
Assignees
@srmainwaring
Labels
generation-1 gz-utils harmonic MacOS Source

Comments

@Voldivh
Copy link
Contributor

Voldivh commented Sep 11, 2023 •
edited
Loading

Setup

  • Os: MacOS
  • BuildType: Source

Links

Checks

  • Instructions work
  • Images (if there are any) match the result

You can find the code used to generate this test case here
@srmainwaring
Copy link

srmainwaring commented Sep 13, 2023 •
edited
Loading

Status

  • Instructions work
  • Images (if there are any) match the result

System

  • MacBook Pro 2021, Apple M1 Max, 32 GB
  • macOS Ventura 13.4
  • Xcode 14.3.1

Details

  • I intend to build all libs from source and so will also be following https://gazebosim.org/docs/harmonic/install_osx_src

  • The colcon build instructions suggest using dart 6.10 and setting the CMAKE_PREFIX_PATH, however the brew binary install uses the rolling version. The instructions should be updated.

  • The CMAKE_PREFIX_PATH needs to be set for qt@5

  • qt should be unlinked when building from source to avoid conflicts

brew unlink qt
  • Cross check version and dependencies using
$brew info osrf/simulation/gz-harmonic
==> osrf/simulation/gz-harmonic: stable 1.0.0~pre2, HEAD
Collection of gazebo simulation software
https://github.com/gazebosim/gz-harmonic
Not installed
From: https://github.com/osrf/homebrew-simulation/blob/HEAD/Formula/gz-harmonic.rb
License: Apache-2.0
==> Dependencies
Build: cmake ✘, python@3.11 ✘
Required: gz-cmake3 ✘, gz-common5 ✘, gz-fuel-tools9 ✘, gz-gui8 ✘, gz-launch7 ✘, gz-math7 ✘, gz-msgs10 ✘, gz-physics7 ✘, gz-plugin2 ✘, gz-rendering8 ✘, gz-sensors8 ✘, gz-sim8 ✘, gz-tools2 ✘, gz-transport13 ✘, gz-utils2 ✘, pkg-config ✔, sdformat14 ✘
==> Options
--HEAD
	Install HEAD version
  • Build dependencies
colcon build --merge-install --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTING=OFF -DCMAKE_MACOSX_RPATH=FALSE -DCMAKE_INSTALL_NAME_DIR=$(pwd)/install/lib --packages-select gz-cmake3
Starting >>> gz-cmake3
--- stderr: gz-cmake3                              
CMake Warning:
  Manually-specified variables were not used by the project:

    CMAKE_INSTALL_NAME_DIR
    CMAKE_MACOSX_RPATH


warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 102 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLANG_ASSISTED_PARSING' at line 1072 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_OPTIONS' at line 1080 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_DATABASE_PATH' at line 1090 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'HTML_TIMESTAMP' at line 1237 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1529 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1837 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_TIMESTAMP' at line 1853 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1927 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2032 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2219 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2261 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2268 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2494 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 102 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLANG_ASSISTED_PARSING' at line 1072 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_OPTIONS' at line 1080 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_DATABASE_PATH' at line 1090 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'HTML_TIMESTAMP' at line 1237 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1529 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1837 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_TIMESTAMP' at line 1853 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1927 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2032 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2219 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2261 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2268 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2494 of file '/Users/rhys/Code/osrf/gz_harmonic_ws/build/gz-cmake3/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
---
Finished <<< gz-cmake3 [1.22s]

Summary: 1 package finished [1.42s]
  1 package had stderr output: gz-cmake3

  • The doxygen api.in file could be cleaned up for building on macOS. There are a number of options that are either deprecated or not compiled into the brew version of doxygen.

  • gz-tools2 builds clean

% colcon build --merge-install --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTING=OFF -DCMAKE_MACOSX_RPATH=FALSE -DCMAKE_INSTALL_NAME_DIR=$(pwd)/install/lib --packages-select gz-tools2
Starting >>> gz-tools2
Finished <<< gz-tools2 [1.71s]                     

Summary: 1 package finished [1.90s]
  • gz-utils2 builds clean
% colcon build --merge-install --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTING=OFF -DCMAKE_MACOSX_RPATH=FALSE -DCMAKE_INSTALL_NAME_DIR=$(pwd)/install/lib --packages-select gz-utils2
Starting >>> gz-utils2
Finished <<< gz-utils2 [1.68s]                     

Summary: 1 package finished [1.87s]

Also builds clean using

cd ./src/gz-utils && mkdir build && cd build
cmake .. && make -j8

Tests

% make test
\Running tests...
Test project /Users/rhys/Code/osrf/gz_harmonic_ws/src/gz-utils/build
      Start  1: UNIT_Environment_TEST
 1/12 Test  #1: UNIT_Environment_TEST ...............   Passed    0.32 sec
      Start  2: check_UNIT_Environment_TEST
 2/12 Test  #2: check_UNIT_Environment_TEST .........   Passed    0.04 sec
      Start  3: UNIT_NeverDestroyed_TEST
 3/12 Test  #3: UNIT_NeverDestroyed_TEST ............   Passed    0.13 sec
      Start  4: check_UNIT_NeverDestroyed_TEST
 4/12 Test  #4: check_UNIT_NeverDestroyed_TEST ......   Passed    0.03 sec
      Start  5: INTEGRATION_deprecated_TEST
 5/12 Test  #5: INTEGRATION_deprecated_TEST .........   Passed    0.13 sec
      Start  6: check_INTEGRATION_deprecated_TEST
 6/12 Test  #6: check_INTEGRATION_deprecated_TEST ...   Passed    0.03 sec
      Start  7: INTEGRATION_subprocess_TEST
 7/12 Test  #7: INTEGRATION_subprocess_TEST .........   Passed    0.52 sec
      Start  8: check_INTEGRATION_subprocess_TEST
 8/12 Test  #8: check_INTEGRATION_subprocess_TEST ...   Passed    0.03 sec
      Start  9: INTEGRATION_ImplPtr_TEST
 9/12 Test  #9: INTEGRATION_ImplPtr_TEST ............   Passed    0.26 sec
      Start 10: check_INTEGRATION_ImplPtr_TEST
10/12 Test #10: check_INTEGRATION_ImplPtr_TEST ......   Passed    0.03 sec
      Start 11: UNIT_cli_TEST
11/12 Test #11: UNIT_cli_TEST .......................   Passed    0.12 sec
      Start 12: check_UNIT_cli_TEST
12/12 Test #12: check_UNIT_cli_TEST .................   Passed    0.03 sec

100% tests passed, 0 tests failed out of 12

Total Test time (real) =   1.67 sec

This was referenced Sep 13, 2023
Closed
Closed
Closed
Closed
Closed
Closed
@mjcarroll
Copy link

The doxygen api.in file could be cleaned up for building on macOS. There are a number of options that are either deprecated or not compiled into the brew version of doxygen.

This is true for non-macOS platforms as well. utils has to support bionic-jammy, which is a large spread of doxygen versions. It's been discussed to address it, but hasn't been a high priority.

@srmainwaring srmainwaring mentioned this issue Sep 13, 2023
Closed
2 tasks
@srmainwaring
Copy link

@mjcarroll - no prob. I maintain patches for my own dev environment. Had thought it may have been macOS specific.

This was referenced Sep 13, 2023
Closed
Closed
@azeey
Copy link
Contributor

azeey commented Sep 25, 2023

I'll go ahead and close this since the only issue is doxygen warnings, which I'm not sure if we can easily fix.

@azeey azeey closed this as completed Sep 25, 2023
@azeey
Copy link
Contributor

azeey commented Sep 26, 2023

Hi @srmainwaring, congratulations! You are one of our top contributors in the Harmonic tutorial party. Can you send your email address to addisu@openrobotics.org so we can send you the Harmonic t-shirt?

@azeey
Copy link
Contributor

azeey commented Nov 16, 2023

Hi @srmainwaring, congratulations! You are one of our top contributors in the Harmonic tutorial party. Can you send your email address to addisu@openrobotics.org so we can send you the Harmonic t-shirt?

Hi @srmainwaring, I don't think I ever received your email. If you're still interested in the Harmonic t-shirt, please email me.

@azeey azeey mentioned this issue Aug 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@srmainwaring srmainwaring

Labels
generation-1 gz-utils harmonic MacOS Source
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@azeey @mjcarroll @srmainwaring @Voldivh