Welcome to CAF.base’s documentation!

Python package containing a collection of core classes and definitions used in the Common Analytical Framework.

CAF.base source code is available on GitHub.

Common Analytical Framework

This package is sits within the Common Analytical Framework (CAF), which is a collaboration between transport bodies in the UK to develop and maintain commonly use transport analytics and appraisal tools.

Contents

• Quick Start
  • Pip
  • conda-forge
  • Pipx
  • Usage
    • Python
• User Guide
  • Tool Usage
    • Graphical User Interface
    • Command-Line Interface
  • Tutorials
  • Code Examples
• API Reference
  • caf.base
    • BalancingZones
    • DVector
    • Segment
    • Segmentation
    • SegmentationInput
    • ZoningSystem
    • caf.base.data_structures
    • caf.base.segmentation
    • caf.base.segments
    • caf.base.zoning

Indices and tables

• Index

• Module Index

• Search Page

Todo

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

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cafbase/checkouts/stable/docs/source/start.rst, line 4.)

Todo

Does CAF.base support being installed with Pipx?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cafbase/checkouts/stable/docs/source/start.rst, line 28.)

Todo

Does CAF.base have a CLI or GUI?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cafbase/checkouts/stable/docs/source/start.rst, line 36.)

Todo

Does CAF.base have a suggested alias?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cafbase/checkouts/stable/docs/source/start.rst, line 44.)

Todo

Does CAF.base have a GUI?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cafbase/checkouts/stable/docs/source/usage/index.rst, line 12.)

Todo

Does CAF.base have a CLI?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/cafbase/checkouts/stable/docs/source/usage/index.rst, line 18.)