Install Guide

Please read the following sections carefully before installing the software to avoid any problems.

Requirements

Python 3.8 or higher (3.12 is currently not supported)
FlightGear 2020.3.18 or higher

Users

Tip

If you only want to use pycasx as a command-line tool and not develop it, you can install it via pip or pipx. However, pipx is recommended, as it will install the package in an isolated environment and thus not interfere with other packages.

Installation via `pipx`

Ensure you have pipx installed. If not, install it via

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Afterwards, install pycasx via

pipx install git+https://https://github.com/DLR-KI/pycasx.git

Installation via `pip`

Warning

This is not recommended! Proceed at your own risk! For just using the package, pipx is recommended.

First, clone the repository into a directory of your choice:

git clone https://https://github.com/DLR-KI/pycasx.git

Then, it is recommended to create a virtual environment for the software:

pip install virtualenv
virtualenv .pycasx-venv
source .pycasx-venv/bin/activate

Afterwards, install the software and its dependencies:

pip install -e .

Note

For some virtual environments, especially with Windows, you might need to use python instead of python3 and might also need to use python -m pip instead of pip.

Developers

Installation

First, clone the repository into a directory of your choice:

git clone https://https://github.com/DLR-KI/pycasx.git

Then, it is recommended to create a virtual environment for the software:

pip install virtualenv
virtualenv .pycasx-venv
source .pycasx-venv/bin/activate

Afterwards, install the software and its dependencies:

pip install -e '.[all]'

Next, install the provided pre-commit hooks:

pre-commit install

pre-commit

Prior to any commit, the hooks defined in .pre-commit-config.yaml will be ran. A failure in any hook will block the commit. Although, most of the errors, like formatting, will correct themselves. You just have to re-add all changed files and commit again. Be also aware, that the pipeline can take a few seconds to complete.

Alternatively, you can run the pipeline at any time to invoke changes before they block commits with

pre-commit run --all-files

Running the pre-commit pipeline manually once before the first commit is recommended. It will install all required tools and dependencies and you’ll see what’s going on. Otherwise you might be surprised why committing takes so long.

VS Code

For VS Code, we provide a set of recommended extensions. Please install them to smooth the development process. You’ll find them in your extensions tab under the Workspace Recommendations section.