Skip to content

85. Setting up the ESR Kit environment

Before you can run test scenarios using the Evaluation Solution Reference (ESR) Kit, you must first complete the environment setup. This setup is a critical prerequisite, as it ensures that all necessary data and configurations are in place.

The setup process includes:

  • Downloading all required data assets
  • Exporting essential environment variables

These steps are required to ensure that Foretify tools and scenario runners can correctly access the resources and configuration files needed for execution.

Warning

Skipping or misconfiguring the environment setup will result in failures when running test scenarios.

Only after the environment setup is properly completed can you proceed with running test scenarios using the ESR Kit. Once the environment is configured, you can run test flows using a single command.

Note for Foretellix Internal Users

If you are not using the installer, additional setup is required. Refer to the ref_kit/README.txt file for detailed instructions.

85.1 Step 1: Install Foretify

Install the latest Foretify version and download the drive_logs folder to your local machine. Contact your local Application Engineer for assistance.

85.2 Step 2: Initialize the environment

The ESR Kit uses two key directories:

  • drive_logs: Contains input data drive logs. FTLX object list format is supported.
  • work_dir: This is a user-defined folder used to store all processed outputs, including generated ROI, ingestion runs, and matches.

References to both directories are used throughout the reference kit's scripts via the environment variables ESR_KIT_DRIVE_LOGS and ESR_KIT_WORK_DIR, respectively. Both variables must be initialized accordingly. ESR_KIT_WORK_DIR may point to an existing directory or to a new directory to be created within an existing directory structure.

 export ESR_KIT_DRIVE_LOGS=<your_local_drive_logs_path>
 export ESR_KIT_WORK_DIR=<your_local_work_dir_path>

Notes

The environment must be set up for every terminal session. Whenever the reference kit is used in a new session, run: 

export ESR_KIT_DRIVE_LOGS=<path to drive_logs>
export ESR_KIT_WORK_DIR=<path to output directory>
In the case where these paths are unlikely to change, these commands may be added to the user's .bashrc for convenience.

Notes

The downloaded drive_logs folder contains unprocessed drive logs, as well as curated object lists. These are organized in the following structure:

$ESR_KIT_DRIVE_LOGS/object_lists/
├── highway
│   └── M497_FTX_Highway
└── suburban_odd
    └── M499_FTX_suburban

Regardless of which logs within this folder will be used when running the Evaluate pipeline, the variable ESR_KIT_DRIVE_LOGS must point to the root of the drive_logs folder.

85.3 Step 3: Load environment for each session

For every new terminal session, make sure that ESR_KIT_DRIVE_LOGS and ESR_KIT_WORK_DIR are set:

export ESR_KIT_DRIVE_LOGS=<path to drive_logs>
export ESR_KIT_WORK_DIR=<path to output directory>

This ensures all required environment variables are correctly set for the session.