caf.cvt 0.1.1

Climate Vulnerability Tool to assess the vulnerability of the transport network in the North to climate hazards.

CAF.cvt

CAF.cvt is a python model that takes climate and transport data and generates a climate risk assessment for the North's key transport infrastructure.

[!TIP] For more detailed information including a user guide, tutorials and API reference see the full caf.cvt 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
  • Command Line
• Documentation
• What is CAF?
• Contribution
• Contact Us

Overview

What does it do?

The Common Analytical Framework (CAF) Climate Vulnerability Tool (CVT) is a geospatial python package that translates complex climate and infrastructure data into a set of climate risk assessments for the North of England's key transport networks.

Main Features

• Data Cleaning - Reads and cleans a wide variety of climate and transport datasets, preprocessing into a standard format in preparation for analysis.

• Apply Functional Rules - Applies a set of funtional rules and spatial overlays to the climate data to translate complex values into distinct hazard categories and grids.

• Infrastructure Layering - Layers infrastructure on top of hazard grids to assign risk to the transport assets.

Work-in-Progress

There are currently no work-in-progress features.

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

Who is it for?

• Target audience: Transport Analysts, Transport Planners, Climate Researchers
• CAF Analytical Stage: Modelling

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

Where to get it

[!IMPORTANT] caf.cvt has not been published yet so cannot be installed from conda-forge or PyPI, see Installation from GitHub.

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

conda install -c conda-forge caf.cvt

pip install caf.cvt

[!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.cvt"

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

Usage

CAF.cvt provides and Command-line (CLI) and graphical interface (GUI) to use many of it's features without the need to write any Python code, see the Tool Usage section of the user guide for more details.

Command Line

The tool can be run from command line, with the command:

caf.cvt

See Command-Line Interface (User Guide) for full explanations of the parameters.

Documentation

The code documentation is hosted at https://cafcvt.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