VTL Engine Documentation

The VTL Engine is a Python library that allows you to validate, format and run VTL scripts. It is a Python-based library around the VTL Language 2.1

The vtlengine library provides full SDMX compatibility:

  • Direct SDMX file loading: Load SDMX-ML, SDMX-JSON, and SDMX-CSV files directly in the run() and semantic_analysis() functions

  • pysdmx integration: Work with pysdmx objects (Schema, DataStructureDefinition, Dataflow, PandasDataset)

  • Automatic format detection: SDMX files are automatically detected by extension

  • Flexible mappings: Map SDMX URNs to VTL dataset names using the sdmx_mappings parameter

Check the pysdmx documentation for more information about working with SDMX data.

Installation

Requirements

The VTL Engine requires Python 3.9 or higher.

Install with pip

To install the VTL Engine on any Operating System, you can download it from pip:

pip install vtlengine

Important

It is recommended to install any python package in a virtual environment. Please follow these steps

S3 Extra

If you would like to use the S3 capabilities, you need to install the s3 extra:

pip install vtlengine[s3]

The S3 extra is based on the pandas[aws] extra, which requires to set up some environment variables. Please check the boto3 documentation