Requirements

The required software is listed below. Regarding the corresponding software versions, you will find the detailed information in the Release Notes.

Operating System

Continuous delivery / integration (CD/CI) runs on Ubuntu and development is also done with Windows 10/11.

For the Windows operating systems, only additional the functionality of the make tool must be made available, e.g. via Make for Windows

The command-line shells supported are:

Operating system	Command-line shell(s)
Ubuntu	bash
Windows 10/11	cmd and PowerShell

For Ubuntu, the end-of-line character and the execution authorization may need to be adjusted for the shell scripts. If the dos2Unix program is installed, the necessary adjustments can be made using the script``./scripts/run_prep_bash_scripts.sh`` (Ubuntu).

Python

This project utilizes Python from version 3.10, which introduced significant enhancements in type hinting and type annotations. These improvements provide a more robust and clear definition of function parameters, return types, and variable types, contributing to improved code readability and maintainability. The use of Python 3.12 ensures compatibility with these advanced typing features, offering a more structured and error-resistant development environment.

Miniconda

Some of the Python libraries required by the project are exclusively available through Conda. To maintain a minimal installation footprint, it is recommended to install Miniconda, a smaller, more lightweight version of Anaconda that includes only Conda, its dependencies, and Python.

By using Miniconda, users can access the extensive repositories of Conda packages while keeping their environment lean and manageable. To install Miniconda, follow the instructions provided in the scripts directory of the project, where operating system-specific installation scripts named run_install_miniconda are available for Windows (CMD shell) and, Ubuntu (Bash shell).

Utilizing Miniconda ensures that you have the necessary Conda environment with the minimal set of dependencies required to run and develop the project efficiently.

Docker Desktop

The project employs PostgreSQL for data storage and leverages Docker images provided by PostgreSQL to simplify the installation process. Docker Desktop is used for its ease of managing and running containerized applications, allowing for a consistent and isolated environment for PostgreSQL. This approach streamlines the setup, ensuring that the database environment is quickly replicable and maintainable across different development setups.

MS Access Database Engine- only for Windows

This Software consists of a set of components that facilitate the transfer of data between existing Microsoft Office files such as Microsoft Office Access (*.mdb and *.accdb) files and Microsoft Office Excel (*.xls, *.xlsx, and *.xlsb) files to other data sources. Connectivity to existing text files is also supported.

DBeaver Community - optional

DBeaver is recommended as the user interface for interacting with the PostgreSQL database due to its comprehensive and user-friendly features. It provides a flexible and intuitive platform for database management, supporting a wide range of database functionalities including SQL scripting, data visualization, and import/export capabilities. Additionally, the project includes predefined connection configurations for DBeaver, facilitating a hassle-free and streamlined setup process for users.