caf.viz 0.1.2

Visualisation functionality and tools for transport related data.

CAF.viz

[!WARNING]
This package is in an early stage of development so features may change or be removed. If using this package it is recommended to set a specific version and check before upgrading to a new version.

Visualisation functionality and tools for transport related data.

[!TIP] For more detailed information including a user guide, tutorials and API reference see the full caf.viz documentation

Table of Contents

• Table of Contents
• Overview
  • What does it do?
  • Main Features
    • Work-in-Progress
  • Who is it for?
• Where to get it
  • Installation from GitHub
• Usage
• Documentation
• What is CAF?
• Contribution
• Contact Us

Overview

What does it do?

[!IMPORTANT] This section of the README hasn't been written yet, but it will contain a brief description of what the tool is intended to do.

Main Features

• Simplified 2D graphs - wrappers around matplotlib to simplify the creation of basic 2D plots (scatter, line and hexbin) and to simplify the creation of figures with multiple Axes.
• TfN Stylesheet - custom stylesheet for matplotlib using TfN's colour scheme.

Work-in-Progress

• Static Heatmaps - wrapper around GeoPandas and matplotlib to simplify the creation of heatmap images (see #24).

[!WARNING] These features are work-in-progress and are not available in a released version of caf.viz, to access these features a specific branch of caf.viz should be installed, see Installation from GitHub.

Who is it for?

• Target audience: GIS Analysts, Transport Analysts, Data Analysts
• CAF Analytical Stage: Analysis, Appraisal, Evaluation

For more details on CAF Analytical Stages see the description within TfN's GitHub homepage

Where to get it

The latest released version are available at the Python Package Index (PyPI) and on Conda.

conda install -c conda-forge caf.viz

pip install caf.viz

[!TIP]

• See the Quick Start Guide for more detailed instructions.
• See the requirements.txt for the full list of package dependencies.

Installation from GitHub

[!WARNING] Unreleased GitHub versions should not be considered stable.

The latest, unreleased, version can be installed directly from GitHub using:

pip install "git+https://github.com/transport-for-the-north/caf.viz"

[!TIP] pip install can install a specific tag, or branch, using @{tag-name} after the git URL.

Usage

CAF.viz doesn't currently provide a CLI or GUI so should be called from Python to use, see the Tool Usage section of the user guide for more details.

Documentation

The code documentation is hosted at https://cafviz.readthedocs.io/en/stable/.

What is CAF?

This tool is part of TfN's Common Analytical Framework (CAF). CAF is Transport for the North's structured suite of analytical tools designed to support transport modelling, appraisal, and strategic decision-making.

More information on CAF and details on other CAF tools can be found on TfN's GitHub Homepage.

Contribution

We encourage use of, and contributions to, the repositories within this organisation, licenses are provided within the repositories and the organisation contribution guide provides details for contributions.

---

Contact Us

For further information about using this tool or CAF tools in your projects and work contact Transport for the North - [e-mail]

---

Go to Top