## On this page

  

 

 # Install Simulation Framework

 Last update: 16.07.2025 

<a class="anchor" id="autotoc_md50"></a> The Simulation Framework includes a robust installation script to streamline setup, dependency management, license configuration, and example integration. The installer supports interactive and non-interactive modes, allowing flexibility across local environments and containerized deployments.

## <a class="anchor" id="autotoc_md51"></a>Requirements

- **Operating System**: Ubuntu 24.04
- **Privileges**: Root privileges may be required (via `sudo`) to install system packages and write to `/bin/` or `/ansys_inc`
- **Dependencies**: Installed automatically by the script if not already present:
    - `build-essential`, `manpages-dev`, `doxygen`, `graphviz`, `proj-bin`
    - `gcc-11`, `g++-11`, `wget`, `software-properties-common`
    - Bazelisk v1.5.0 or newer

---

## <a class="anchor" id="autotoc_md53"></a>Installation Options

Run the installer script with one or more of the following options:

./install.sh [options]



### <a class="anchor" id="autotoc_md54"></a>Basic Options

Option Description `-h, --help` Display help and exit `-i, --input=<file>` Path to the SimFwk `.deb` package `-o, --output=<dir>` Destination directory for installing the framework `-y, --yes` Auto-confirm all prompts (non-interactive mode) ### <a class="anchor" id="autotoc_md55"></a>Installation Step Flags

You may select specific steps or run the full installer:

Flag Step `-a, --all` Run all steps (default when no specific step is selected) `-s, --simfwk` Unpack Simulation Framework `.deb` package `-e, --example` Unpack `simfwk_examples.tar.gz` if found `-b, --bazel` Set up Bazel workspace and Ansys licensing symlinks `-l, --license` Set up symbolic links for Ansys Licensing Client only `-d, --dependencies` Install required system dependencies `-g, --documentation` Generate Doxygen API documentation from installed sources ---

## <a class="anchor" id="autotoc_md57"></a>Example Full Installation

To run a full installation with default locations and all steps:

./install.sh --all --yes



This performs the following:

1. Installs required dependencies
2. Unpacks the `.deb` package (auto-detected or provided)
3. Sets up Ansys license symlinks
4. Configures Bazel (Bazelisk v1.5.0)
5. Unpacks examples (if found)
6. Generates Doxygen documentation

---

## <a class="anchor" id="autotoc_md59"></a>License Configuration

After installation, ensure the Ansys license environment variable is set before running any simulation:

export ANSYSLMD_LICENSE_FILE=1055@your-license-host



The installer also attempts to create a symlink for Ansys Licensing Client:

/ansys_inc/v252/licensingclient → $INSTALL_PATH/lib/external/anslic_client/licensingclient



---

## <a class="anchor" id="autotoc_md61"></a>Output

Once complete, you will find:

- The core framework under: `simulation_framework/`
- Examples (if installed): `simfwk_examples/`
- Doxygen docs (if generated): `simulation_framework/documentation/doxygen/html/index.xhtml`

---

## <a class="anchor" id="autotoc_md63"></a>Verifying the Installation

After installation, verify that the framework runs properly by executing a default simulation:

cd simulation_framework/bin

./simfwk_cli -s ./solver_setting_configuration.json



Make sure:

- A valid license is configured (`ANSYSLMD_LICENSE_FILE` is set)
- Your system can connect to the Ansys License Manager

If successful, you’ll see execution logs in the console. Simulation output will be written to:

/tmp/simfwk-out



This default output directory can be changed via the `output_directory` setting in `solver_setting_configuration.json`.