Getting started with IDA Tunnel API
The IDA API (API = Application Programming Interface) offers a wide range of possibilities for interaction between IDA Tunnel and various programming languages. This includes tasks such as executing user-defined batch runs and creating customized reports. In this guide, we will walk through the process of crafting a simple Python script that initiates multiple simulations in batch mode, each with a distinct tunnel size. We will then compare the results obtained from these simulations.
Note: Using the API to run IDA TUNNEL simulations requires a separate license.
What's most valuable in this exercise is to become acquainted with the API, understand the examples provided, and then consider how you can apply this knowledge to your own specific applications, building upon the given example.
This exercise uses files from the
The IDA Tunnel Python API
The IDA Tunnel API provides a means to control IDA Tunnel through programming languages like Python, Julia, and Javascript, or other languages that can interact with Windows libraries (such as .dll files). In essence, an API serves as a bridge for communication between two programs.
- Useful for:
- Changing the Fire location and Entry vehicle traffic by varying parameters in the Example: Fire Move.
- Data optimization and reports generation in Excel/Word in the Example: Customized reports.
- Starting Batch Runs in parallel/series (Beta) manner in Example: Batch Processings.
- Advantages:
- With some basic Python skills, the API gives you powerful control of IDA Tunnel.
- You can start with the example scripts shown in this guide and work out your own examples.
Download the here. The ZIP folder contains example Python scripts and IDA Tunnel-related files you need for the following tutorials.