Quick Start

Todo

Write brief description about the possible ways for using the tool e.g. CLI, GUI and importing in Python.

CAF.base is provided as a Python package and a command-line utility. The command-line utility aims to make some of the commonly used functionality available without needing to use Python code, see :ref:`usage` for details.

CAF.base can be installed from pip, conda-forge or pipx (when using as a command-line utility).

Pip

Installing through pip is easy and can be done in one command: pip install caf.base

conda-forge

Installing through conda-forge is easy and can be done in one command: conda install caf.base -c conda-forge

Pipx

Todo

Does CAF.base support being installed with Pipx?

Usage

Todo

Does CAF.base have a CLI or GUI?

More details can be found in Tool Usage.

Python

Todo

Does CAF.base have a suggested alias?

When using CAF.base functionality within Python:

import caf.base

The User Guide contains Tutorials and Code Examples, which explain available functionality. For a detailed look at the package API see API Reference.