Web Analytics Made Easy - Statcounter
Skip to content

Installation of SDK#

Download SAMSON SDK#

All the users can be developers! You can start right away by downloading the SDK from the Download page on SAMSON Connect - click on Download the SAMSON SDK once signed in.

Requirements#

A 64-bit architecture with a 64-bit operating system:

  • Windows 11, Windows 10.
  • Linux: Ubuntu 22.04 and newer, CentOS, and other similar Linux OS.
  • macOS (64-bit Intel and ARM): Sequoia (macOS 15), Sonoma (macOS 14), Ventura (macOS 13), Monterey (macOS 12), Big Sur (macOS 11).

Installation with older versions of operating systems has not been tested. If you experience any problems with installation, please, check the SAMSON Connect Forum.

First, you need to install SAMSON. If you do not have SAMSON installed, please, refer to the Installing SAMSON first. If you already have SAMSON, please, follow the steps of this installation guide.

For other version of SAMSON SDK, check requirements here: all versions.

Requirements on Windows#

  • A compatible compiler: Visual Studio 2022 Community or Professional or an older version (VS 2019). SAMSON and SAMSON Extensions distributed on SAMSON Connect are built with Visual Studio 2017 for compatibility reasons.
  • IDE: Visual Studio 2022 Community or Professional or an older version (VS 2019).
  • CMake v.3.10 or newer. The SAMSON SDK uses CMake to easily and portably generate projects for development environments. During the installation of CMake, please, specify to add CMake to the Path environment variable. If you have not added CMake to the Path environment variable during the installation process, you can do it by adding the path to the cmake.exe file when using it - by default, this should be C:\Program Files\CMake\bin\cmake.exe.

  • Qt 6.5.2 for 64-bit architecture. Download the Qt installer from https://www.qt.io/get-started and choose to install Qt 6.5.2 and Qt Creator.

    Add the path to Qt binaries into the system Path environment variable (see how to set the path and environment variables in Windows), i.e. the path to the qmake.exe file and dll libraries:

    YourQtPath\Qt\6.5.2\msvc2019_64\bin

    YourQtPath\Qt\6.5.2\msvc2017_64\bin

    This path should be the first one in the Path environment variable. You might also define QT_CMAKE_INCLUDE_DIR environment variable which should be equal to the path to the lib\cmake folder in your Qt installation (e.g.: QT_CMAKE_INCLUDE_DIR = YourQtPath\Qt\6.5.2\msvc2019_64\lib\cmake), otherwise you can just supply this path when building your extensions.

Requirements on Linux#

  • A compatible compiler: gcc/g++ v.5.4+
  • CMake v.3.10 or newer. The SAMSON SDK uses CMake to easily and portably generate projects for development environments. If you installed CMake not via the repository but from sources you will need to add the path to your CMake installation to your PATH environment variable.
  • Qt 6.5.2 for 64-bit architecture. Download the Qt installer from https://www.qt.io/get-started and choose to install Qt 6.5.2 and Qt Creator.
  • IDE: Qt Creator (should be available when you install Qt) or the one you prefer.

Requirements on macOS#

  • A compatible compiler: CLang compiler (available when you install XCode)
  • CMake v.3.10 or newer. The SAMSON SDK uses CMake to easily and portably generate projects for development environments. If you installed CMake not via the repository but from sources you will need to add the path to your CMake installation to your PATH environment variable.

  • Qt 6.5.2 for 64-bit architecture. Download the Qt installer from https://www.qt.io/get-started and choose to install Qt 6.5.2 and Qt Creator.

    Add to the DYLD_FRAMEWORK_PATH environment variable the path to the macos/lib folder in the Qt installation. Define an environment variable called QT_CMAKE_INCLUDE_DIR equal to the path to the macos/lib/cmake folder in the Qt installation. For that, open the .zprofile file or the .bash_profile file (depending on the version of your macOS) in your user directory and add the next lines:

    export DYLD_FRAMEWORK_PATH=YourQtPath/Qt/6.5.2/macos/lib:$DYLD_FRAMEWORK_PATH
export QT_CMAKE_INCLUDE_DIR=YourQtPath/Qt/6.5.2/macos/lib/cmake

    If the Debug version of the Qt framework is used in the Debug mode, then you might also need to add the following line (see: Debugging Techniques: With Frameworks):

    export DYLD_IMAGE_SUFFIX=_debug

  • IDE: Qt Creator (should be available when you install Qt) or XCode.

Installation steps#

The SAMSON SDK installation procedure consists of the following steps described below.

Step 1: Downloading SAMSON SDK#

Sign in to the SAMSON Connect, go to the Download page, and click on Download the SAMSON SDK.

Developer key#

During the installation of the SDK, you will be asked to provide your personal developer key - you should see it next to the download button and you can always check it on your account page.

Note

The developer key is your personal key and should not be shared with others.

Step 2: Installing SAMSON SDK#

Once you have downloaded the SAMSON SDK and prepared your environment as indicated in the Requirements section, you can launch the installer. You can specify the location where SAMSON SDK will be installed during the installation procedure by choosing the "Advanced mode".

Installing on Windows#

Double-click on the executable file and follow the installation steps.

By default, the SDK is installed into C:\Users\%USERNAME%\OneAngstrom folder. You can change this location during installation by choosing "Advanced mode". Inside this folder, you will find a subfolder corresponding to the version of the SDK (e.g., 6.0.2).

SAMSON SDK Installation

Installing on Linux#

  1. Open the terminal and go to the folder where SAMSON SDK installer was saved:

    cd ~/Downloads/

  2. Make the installer executable:

    chmod +x SAMSON-Developer-Setup.run

  3. Run the installer (please, do not use sudo here):

    ./SAMSON-Developer-Setup.run

  4. Follow the installation steps.

Installing on macOS#

  1. Double-click on the SAMSON-Developer-Setup.dmg file you have downloaded to make its content available. A new window will be openned showing the content of the .dmg file, which should be SAMSON-Developer-Setup.app. Double-click on the SAMSON-Developer-Setup.app. The dialog window should appear with a security notification, press Open.
  2. Follow the installation steps.
  3. After the installation is done you may eject the .dmg by clicking the eject button in the Finder's sidebar.

The SAMSON SDK is installed by default in the $HOME/OneAngstrom/SAMSON-Sdks/ folder.

Step 3: Running SAMSON Debug#

Once the SAMSON SDK installation is finished, there are some final things to do depending on your OS platform. If you experience any problems please check the SAMSON Connect Forum.

Running on Windows#

By default, SAMSON and its SDK are installed into C:\Users\%USERNAME%\OneAngstrom folder (below is noted as SDK_PATH).

  • Go to SDK_PATH\SAMSON-Sdks\6.0.2\SAMSON-Debug\Binaries.
  • Double-click on SAMSON-Core.exe or SAMSON-Core-Console.exe, it should launch the developers version of SAMSON.

Running on Linux#

By default, SAMSON and its SDK are installed into $HOME/OneAngstrom folder (below is noted as SDK_PATH).

  • Go to SDK_PATH/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries.
  • Open and edit file SAMSON-Core.sh. You need to provide a path to Qt installed in your system, for that modify the following line:
export LD_LIBRARY_PATH=YourQtPath/Qt/6.5.2/gcc_64/lib:$script_dir:$LD_LIBRARY_PATH

Save the file.

  • To launch the developers version of SAMSON, open the terminal in this folder and execute
./SAMSON-Core.sh

You may also need to make executable the following files placed in SDK_PATH/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries: SAMSON-Core.sh and SAMSON-Core:

cd SDK_PATH/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries
ls -la | grep "SAMSON-Core"
chmod +x SAMSON-Core*

For an easy launch (in terminal, from any folder), you may create an alias in your .bachrc file:

alias samson-debug='SDK_PATH/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries/SAMSON-Core.sh'

Running on macOS#

To launch the developers version of SAMSON, open the terminal and go to ~/OneAngstrom/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries folder

cd ~/OneAngstrom/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries
./SAMSON-Core

You may also need to make executable the following files placed in ~/OneAngstrom/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries: SAMSON-Core-Console and SAMSON-Core:

cd ~/OneAngstrom/SAMSON-Sdks/6.0.2/SAMSON-Debug/Binaries
ls -la | grep "SAMSON-Core"
chmod +x SAMSON-Core*

What's next?#

After you have installed SAMSON SDK, you can start developing your SAMSON Extensions, in particular thanks to the SAMSON Extension Generator.

Check out the following tutorials: