Requirements

The required software is listed below. For pinned or recommended versions, see the Release Notes:

  • https://github.com/io-aero/io-template-lib/blob/main/docs/release_notes.md

Operating System

The supported operating system is Ubuntu with the Bash shell. WSL 2 on Windows is supported when Ubuntu is used as the Linux distribution.

Python

This project requires Python 3.12. The installer script scripts/run_install_python.sh installs or updates Python 3.12 on Ubuntu.

Micromamba

Python environments are created with Micromamba from the repository environment files:

  • config/environment.yml for production use

  • config/environment_dev.yml for development use

Use scripts/run_install_micromamba.sh to install or update Micromamba. The do.sh targets conda-prod and conda-dev create or update the project environment.

Docker

Docker is required for container-related targets and for running GitHub Actions locally with act. On native Ubuntu, use scripts/run_install_docker.sh to install Docker Engine. On WSL 2, Docker Desktop for Windows can be used when WSL integration is enabled.

PostgreSQL Client

The PostgreSQL command-line tools are required by database-related maintenance scripts. Use scripts/run_install_postgresql_client.sh to install or update the client tools on Ubuntu.

act

The act CLI is used to run GitHub Actions locally. Use scripts/run_install_act.sh to install or update it.

AWS CLI

The AWS CLI is required for AWS-related workflows and deployment scripts. Use scripts/run_install_aws_cli.sh to install or update AWS CLI v2.

DBeaver Community (optional)

DBeaver is recommended as a graphical user interface for interacting with PostgreSQL databases. Use scripts/run_install_dbeaver.sh to install or update DBeaver Community on Ubuntu.