Requirements¶
The required software is listed below. Regarding the corresponding software versions, you will find detailed information in the Release Notes.
Operating System¶
Continuous delivery/integration (CD/CI) runs on Ubuntu, and development is also done with macOS and Windows 10/11.
The installation of Homebrew is required for macOS. If necessary, Homebrew can be installed with the following command:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
For the Windows operating systems, only the additional 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) |
|---|---|
macOS |
zsh |
Ubuntu |
bash |
Windows 10/11 |
cmd and PowerShell |
For macOS and 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 scripts ./scripts/run_prep_zsh_scripts.zsh (macOS) or ./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.10 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), Ubuntu (Bash shell), and macOS (Zsh 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.