This document provides a comprehensive guide for setting up and deploying the iTwin Capture Modeler Engine on a Linux system. By following this guide, users will be able to successfully install, configure, and run the iTwin Capture Modeler Engine and execute Automaster for project processing.
Create directories to store job queues and temporary files. These directories will help organize your files and make the installation process smoother.
Ctrl + Alt + T to open the terminal.Type the following command and press Enter:
mkdir -p ~/jobqueueThis command creates a new directory called jobqueue inside the home directory.
Environment variables are used to configure the iTwin Capture Modeler. Lets setup the necessary environment variables so that the software knows where to find the job queue and temporary files.
~/.bashrc). (Note : Nano is used for this Guide)Scroll to the bottom of the file.
Depending on whether you are setting up for a trial or production, add the appropriate environment variables for either machine-specific or machine-agnostic licensing. | Note: Replace “XXX” with the appropriate edition (“DESKTOP” or “CENTER”):
Trial Setup:
Machine-Specific License (Trial):
# Trial Setup - Machine-Specific License
export CC_XXX_LICENSING_ACCESSKEY=<Your Trial Machine-Specific Access Key>Machine-Agnostic License (Trial):
# Trial Setup - Machine-Agnostic License
export CC_XXX_LICENSING_AGNOSTIC_ULTIMATEID=<Your Trial Ultimate ID>
export CC_XXX_LICENSING_ACCESSKEY=<Your Trial Access Key>Production Setup:
Machine-Specific License (Production):
# Production Setup - Machine-Specific License
export CC_XXX_LICENSING_ACCESSKEY=<Your Production Machine-Specific Access Key>Machine-Agnostic License (Production):
# Production Setup - Machine-Agnostic License
export CC_XXX_LICENSING_AGNOSTIC_ULTIMATEID=<Your Production Ultimate ID>
export CC_XXX_LICENSING_ACCESSKEY=<Your Production Access Key>Common Environment Settings for Both Trial and Production:
export CC_XXX_JOBQUEUE=~/jobqueue
export TEMP=/tmpReplace XXX and with your actual licensing information, and ensure “DESKTOP” or “CENTER” is correctly specified according to your product edition.
Save and Exit: - If using Nano, to save the file, press Ctrl + O and then press Enter. - If using Nano, to exit the text editor, press Ctrl + X.
Apply the Changes: - Type the following command and press Enter to apply the changes:
source ~/.bashrcIt’s important to verify that the environment variables are set correctly.
Type the following command and press Enter | Note: Replace “XXX” with the appropriate edition (“DESKTOP” or “CENTER”)::
echo $CC_XXX_JOBQUEUE echo $CC_XXX_LICENSING_ACCESSKEY echo $CC_XXX_LICENSING_AGNOSTIC_ULTIMATEID echo $TEMP
The output should display the paths you set for each variable.
.bashrc file. Any mistakes can affect your terminal’s behavior. If unsure, always make a backup of the file before editing:cp ~/.bashrc ~/.bashrc_backup.deb file) from the official Bentley website or your provided link..deb file in a directory of your choice, for example, /tmp..deb FileCtrl + Alt + T to open the terminal.Navigate to the directory where you placed the downloaded file:
cd /tmp.deb File:
Instead of using dpkg, use the apt command to install the package, which automatically manages and installs any missing dependencies:
sudo apt install ./itwincapturemodeler???_YY.MM.mm.pp-1_x64.deb -yTo confirm that iTwin Capture Modeler has been installed correctly, open a terminal and run the following command:
iTwinCaptureModelerEngine --versionThis command will display the version of the iTwin Capture Modeler Engine, confirming that the installation was successful.
While the executable is accessible globally, you may want to access the SDK and sample files located in the installation directory:
ls /opt/iTwinCaptureModeler/sdkThis step is optional but useful if you need to explore or utilize additional resources provided with the installation.
sudo where necessary.sudo apt-get install -f command to resolve them.This section will guide you through installing Python and the iTwin Capture Modeler Python SDK on your Linux system.
Open a terminal and update your package lists:
sudo apt updateInstall the necessary dependencies for adding new repositories:
sudo apt install -y software-properties-commonAdd the Deadsnakes PPA, which contains newer Python versions:
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt updateInstall Python 3.10:
sudo apt install -y python3.10 python3.10-venv python3.10-devCheck the Python version to ensure it’s installed correctly:
python3.10 --versionNavigate to the directory where you want to create the virtual environment and run:
python3.10 -m venv myenvActivate the virtual environment:
source myenv/bin/activateUpgrade pip to the latest version within the virtual environment:
pip install --upgrade pipYou can install the iTwin Capture Modeler Python SDK directly using pip without navigating to the SDK directory. Open your terminal and run the following command:
pip install /opt/itwincapturemodeler/sdk/itwincapturemodeler-YY.MM.mm.pp-cp310-cp310-linux_x86_64.whlReplace itwincapturemodeler-YY.MM.mm.pp-cp310-cp310-linux_x86_64.whl with the actual file name of the SDK package.
To ensure the SDK was installed correctly, you can check the installed packages by running:
pip listLook for the iTwin Capture Modeler SDK in the list to confirm it is installed.
Ctrl + Alt + T to open a new terminal window.Start the engine by typing the following command in the terminal.
iTwinCaptureModelerEngineThis command will launch the iTwin Capture Modeler Engine using the global path settings, which should already be configured during installation
You can use the provided sample data or your own data.
To use the sample data, download it from the provided link: Download Sample Data
Extract the downloaded data to a directory of your choice. For example:
mkdir -p ~/SampleData
tar -xzf path_to_downloaded_file -C ~/SampleDataCopy the automaster.py script from the installation directory to a working directory in your home folder:
cp /opt/itwincapturemodeler/sdk/samples/automaster.py ~/MyProjects/Navigate to the directory where you copied the script:
cd ~/MyProjectsOpen the automaster.py script in a text editor:
Replace the paths with your local references. If you are using the sample data:
photosDirPath = '~/SampleData/Photos'
projectDirPath = '~/Projects/automaster'If you are using your own data, set the photosDirPath and projectDirPath to your data directories:
photosDirPath = '/path/to/your/photos'
projectDirPath = '/path/to/your/project'Save the file by pressing Ctrl + O and then Enter. Exit the text editor by pressing Ctrl + X.
Ctrl + Alt + T.If you set up a virtual environment, activate it:
source ~/myenv/bin/activateNavigate to the directory where you copied the script: containing automaster.py:
cd ~/MyProjectsExecute the script using Python:
python3 automaster.pyautomaster.py encounters errors, double-check the file paths in the script and ensure that the sample data (or your data) is correctly extracted.To ensure the smooth and uninterrupted operation of iTwin Capture Modeler, it is mandatory to whitelist the following URLs within your organization’s network. These URLs are essential for authentication, licensing, data management, and auxiliary services critical to the product's functionality. Failure to whitelist these URLs may result in restricted access to key features or disruptions in service.
URL: https://imsoidc.bentley.com/
Description: Manages authentication and authorization services.
URL: https://ims.bentley.com/
Description: Identity Management System for user accounts.
URL: https://connect-realitydataservices.bentley.com
Description: Used for reality data management and services.
URL: https://api.bentley.com/realitydataanalysis
Description: Supports analysis of reality datasets.
URL 1: https://api.bentley.com/itwins
URL 2: https://api.bentley.com/accesscontrol
Description: APIs for managing and accessing iTwin models and resources.
URL: http://www.acute3d.com/s3c_resources/CameraDB_2.bin
Description: Resource file for camera metadata.Community Forum