Deploying Carmenta Engine 5 Applications on Linux
This article describes how to deploy a Carmenta Engine application on Linux.
On the system, where the deployed application should run, the GNU Standard C++ Library version 4.8 or later, the Expat XML parser library, the Fontconfig library, the FreeType library and the libcurl library needs to be present.
Deployment using packages
An application can be deployed by creating a Linux rpm or deb package. This can be done with deployment tools included in the supported Linux distributions.
On Windows the packages for Linux, that can be used with WSL, is located in the linux folder in the SDK directory.
Regardless of which tool is used, the way to deploy the Carmenta Engine runtime with an application is the same: by adding the carmenta-engine package as a dependency. The package contains all the necessary libraries and other runtime components needed to run the application on the target machine. If the application uses the EcwDataSet to display ECW data, you also need to add a the carmenta-engine-ecw package as a dependency. Java applications should also add the carmenta-engine-java package as a dependency
The package must also supply a Carmenta Engine runtime license key, for instance by embedding it as a text resource in the application executable. See Using a Carmenta Engine 5 runtime license for details.
Carmenta Engine packages
All redistributable Carmenta Engine packages are available in a Carmenta Engine SDK installation. The following packages are available:
Package | Description |
|---|---|
carmenta-engine | Contains all the core functionality and the C++ API wrappers. Must always be included. |
carmenta-engine-java | Contains the Java API wrappers. Must always be included if the application uses the Java API. |
carmenta-engine-ecw | Contains the necessary runtime files to read and display ECW data. Must always be included if the application uses ECW. |
carmenta-engine-python | Contains the Python API wrappers. If the application uses ScriptOperator with Python code in its configuration file, this module must also be included. |
Deploying .NET applications
For a .NET application, you should use the standard deployment method for such applications, i.e. run a 'dotnet publish ...' command. All needed Carmenta Engine components will be copied from the NuGet packages.
dotnet publish --runtime linux-x64 --configuration Release --self-contained --output SimpleTileServer-linux-x64
LD_LIBRARY_PATH=. ./SimpleTileServer
.NET applications that uses the Carmenta Engine .NET Standard API, that can be built on Linux, can also be published for Windows.
Creating an XCOPY installer
A C++ or Java application can be deployed as an XCOPY installation, i.e. an installation where you just copy the application files, including the Carmenta Engine runtime files, into a directory, and run the application from there.
The Carmenta Engine SDK includes a small script /usr/share/carmenta/xcopy/copy-carmenta-engine-runtime that can be used to copy the necessary Carmenta Engine runtime files for an XCOPY installation.
Running the script without any arguments shows a short help message, see below.
Copies Carmenta Engine runtime files to the current directory.
/usr/share/carmenta/xcopy/copy-carmenta-engine-runtime [cpp] [java] [python] [ecw] [mrsid]
cpp Include runtime files for the C++ API.
java Include runtime files for the Java API.
python Include runtime files for the Python API.
ecw Include runtime files for the EcwDataSet.
mrsid Include runtime files for the MrSidDataSet.
To use the script do the following:
Open a Command Prompt.
Create an empty directory into which the files will be copied.
Change directory to the one created in the previous step.
Determine which API is used, cpp, java or python (some applications use more than one).
Determine if the separately provided third-party components ecw or mrsid are used.
Call copy-carmenta-engine-runtime with the arguments for the required APIs and components.
For example, the following command copies the Carmenta Engine Core runtime files, the Carmenta Engine Java API and the runtime files for the MrSidDataSet into the current directory:
/usr/share/carmenta/xcopy/copy-carmenta-engine-runtime java mrsid
For a Java application, a Java Runtime Environment (JRE) version 11 or later must be installed.
LD_LIBRARY_PATH=. java -cp CECore.Java.jar:CEAwt.Java.jar:. HelloWorldJava
For instructions on how to deploy applications on Linux/ARM, see Deploying Carmenta Engine 5 applications on Linux/ARM. To deploy applications on Windows, files from the Carmenta Engine Windows SDK is needed.