Commit fb4e566f authored by René Paris's avatar René Paris
Browse files

fix: Installation instructions and build pipeline 

_Doc_

* Adjust MSYS installation path
* Clarified usage of conan profile
* Add missing paragraph about PYTHON_EXECUTABLE (linux)
* Add missing and remove outdated packages

_CI_

* Make internal conan remote the primary origin
* Update conan remote to center2.conan.io
* Mirrored and adjusted conan recipies
* Add check for missing PYTHON_EXECUTABLE
* Adjusted toolchain for boost/b2 (no MSVC build anymore)
* Add toolchain generator to windows profile (for bzip)
* Updated OpenScenarioEngine to 

Closes #273 #285
parent 829fac68

doc/source/installation_guide/20_install_prerequisites.rst

+19 −7
Original line number Diff line number Diff line
@@ -54,7 +54,11 @@ Installing the Build Environment 
      #. Install MSYS2



         Run the downloaded executable and adjust suggested settings to your needs (defaults are fine).

         In the following, it is assumed that MSYS2 is installed under ``C:\msys64``.



         .. admonition:: Installation Path



            It is assumed that MSYS2 is installed in the directory ``C:\op\msys64``, as our CI scripts depend on this specific path.

            If you choose to install MSYS2 in a different location, please ensure that you update any related configurations to reflect the new installation path, such as the conan profiles mentioned below."



      #. Understand the Build Environment
@@ -161,8 +165,6 @@ The first set of dependencies we need to install in order to successfully compil 
            apt -y install googletest

            apt -y install graphviz

            apt -y install libboost-filesystem-dev

            apt -y install libgmock-dev

            apt -y install libgtest-dev

            apt -y install libprotobuf-dev

            apt -y install libqt5xmlpatterns5-dev

            apt -y install libantlr4-runtime4.9
@@ -271,8 +273,11 @@ The above directory structure will be created by following the instructions of t 
         conan remote list

         conan remote enable conancenter



#. There are two Conan profiles ``conanprofile_linux`` and ``conanprofile_windows`` available in the ``utils/ci/conan/recipe`` folder.

   The compiler version and the path to the MSYS installation in these profiles can be adjusted to suit your specific environment, if necessary.

#. There are two Conan profiles ``conanprofile_linux`` and ``conanprofile_windows`` available in the ``utils/ci/conan/recipe`` folder, which will be automatically used in the next step.



   .. admonition:: Adjustments



      Check and adjust the compiler version and the path to the MSYS installation in these profiles before running the prepare scripts.



   .. note::
@@ -294,12 +299,12 @@ The above directory structure will be created by following the instructions of t 
               export JAVA_HOME=/c/Downloads/zulu/

               export PATH=$PATH:/c/Downloads/zulu/bin



         #. The script ``15_prepare_thirdParty.sh`` also requires the variable PYTHON_WINDOWS_EXE set. This variable refers to the path of the python installation (For ex: It could be either on native Windows or on MSYS).

         #. The script ``15_prepare_thirdParty.sh`` also requires the variable PYTHON_EXECUTABLE set. This variable refers to the path of the python installation (For example: It could be either on native Windows or on MSYS).

            If the python is installed on MSYS then set the variable with the following command.



            .. code-block::



               export PYTHON_WINDOWS_EXE=python3

               export PYTHON_EXECUTABLE=python3



         #. Execute the script ``15_prepare_thirdParty.sh`` on MSYS
@@ -310,6 +315,13 @@ The above directory structure will be created by following the instructions of t 


      .. tab:: Linux



         #. The script ``15_prepare_thirdParty.sh`` also requires the variable PYTHON_EXECUTABLE set. This variable refers to the path of the python installation.



            .. code-block::



               export PYTHON_EXECUTABLE=python3





         #. Execute the script



            .. code-block::

doc/source/installation_guide/_static/msys2_packages.txt

+3 −3
Original line number Diff line number Diff line 
pacman -S  \

    `# for simulator` \

    mingw-w64-x86_64-boost \

    `# for building and running the simulator` \

    make \

    mingw-w64-x86_64-ccache \

    mingw-w64-x86_64-cmake \

    mingw-w64-x86_64-doxygen \

    mingw-w64-x86_64-gcc \

    mingw-w64-x86_64-gdb \

    mingw-w64-x86_64-graphviz \

    mingw-w64-x86_64-gtest \

    mingw-w64-x86_64-make \

    mingw-w64-x86_64-qt5-base \

    mingw-w64-x86_64-qt5-xmlpatterns \

    patch \

    `# for documentation` \

    mingw-w64-x86_64-python \

    mingw-w64-x86_64-python-pip \

utils/ci/conan/conanfile.txt

+18 −27
Original line number Diff line number Diff line 
[requires]

gtest/1.14.0

bzip2/1.0.8

zlib/1.3.1

b2/5.0.0

boost/1.85.0

zlib/1.2.13

minizip/1.2.13

protobuf/3.20.0

protobuf-shared/3.20.0

fmilibrary/2.0.3

libiconv/1.17

libxml2/2.12.5

protobuf-shared/3.20.0

units/2.3.3

open-simulation-interface/3.7.0

gtest/1.14.0

libxml2/2.11.5

mantleapi/v5.1.0

minizip/1.2.13

yase/0.1

openscenario_api/v1.3.1

openscenario_engine/commitid



open-simulation-interface/3.7.0

units/2.3.3



[options]

libxml2/*:shared=False

libxml2/*:include_utils=False

libxml2/*:ftp=False

libxml2/*:http=False

libxml2/*:html=False

libxml2/*:legacy=False

libxml2/*:sax1=False

libxml2/*:zlib=False

msys2/*:no_kill=True

qt/*:with_pq=False

qt/*:with_libpng=False

qt/*:openssl=False

qt/*:opengl=no

qt/*:qtxmlpatterns=True

qt/*:with_x11=False

qt/*:qtwayland=False

b2/*:toolset=gcc

boost/*:shared=True

boost/*:without_chrono=True
@@ -56,11 +39,19 @@ boost/*:without_timer=True 
boost/*:without_type_erasure=True

boost/*:without_url=True

boost/*:without_wave=True

protobuf/*:debug_suffix=False

protobuf-shared/*:debug_suffix=False

libxml2/*:shared=False

libxml2/*:include_utils=False

libxml2/*:ftp=False

libxml2/*:http=False

libxml2/*:html=False

libxml2/*:legacy=False

libxml2/*:sax1=False

libxml2/*:zlib=False

openscenario_engine/*:commit_id_value=6d4b0919262cbee1199f3537be0521145952dd8c

openscenario_engine/*:MantleAPI_version=v5.1.0

openscenario_engine/*:Yase_version=0.1

protobuf/*:debug_suffix=False

protobuf-shared/*:debug_suffix=False



[generators]

CMakeDeps

utils/ci/conan/conanprofile_windows

+2 −1
Original line number Diff line number Diff line
@@ -13,3 +13,4 @@ tools.build:jobs=1 
tools.system.package_manager:mode=install

tools.microsoft.bash:subsystem=msys2

tools.microsoft.bash:path=C:/op/msys64/usr/bin/bash.exe

tools.cmake.cmaketoolchain:generator=MSYS Makefiles

utils/ci/conan/recipes/b2/all/conandata.yml

0 → 100644
+16 −0
Original line number Diff line number Diff line 
sources:

  "4.8.2":

    url: "https://github.com/bfgroup/b2/archive/4.8.2.tar.gz"

    sha256: "220edfbd5022394c5dc264dfdd8bf6d3ec53b784db87461026bb23ea9d9ec4bd"

  "4.9.6":

    url: "https://github.com/bfgroup/b2/releases/download/4.9.6/b2-4.9.6.tar.bz2"

    sha256: "10c1344c751fcf5a1f9ec6f52c02626cfbf78a4806f7817949b115e107bbbc5f"

  "4.10.0":

    url: "https://github.com/bfgroup/b2/releases/download/4.10.0/b2-4.10.0.tar.bz2"

    sha256: "aee0185473141d4acb56e39c78758b1016e66393ea5ca86ef29403bd9258f2e2"

  "4.10.1":

    url: "https://github.com/bfgroup/b2/releases/download/4.10.1/b2-4.10.1.tar.bz2"

    sha256: "d0818276955c3351eac26e4aa1e61046cfded88773232d76f2833c93bb917633"

  "5.0.0":

    url: "https://github.com/bfgroup/b2/releases/download/5.0.0/b2-5.0.0.tar.bz2"

    sha256: "1ef867f7d374345a948baca025ed277dadda05a68439aa383a06aceb9911f7d3"

Copyright © Eclipse Foundation AISBL. All rights reserved.     Privacy Policy | Terms of Use | Copyright Agent