SourceCode.paths

SourceCode.paths#

paths.py#

Centralized path configuration for FTT

This module provides a single place to configure the data directories used by the model (Inputs and Utilities). Override the defaults before instantiating RunFTT when using FTT as an imported package with local data.

Example usage#

Default behaviour (uses the data bundled with the repository):

from future_technology_transformation import RunFTT
model = RunFTT()

Using custom data directories:

from future_technology_transformation import RunFTT, set_paths
set_paths(
    inputs_path="/path/to/my/Inputs",
    utilities_path="/path/to/my/Utilities",
)
model = RunFTT()

Or equivalently via RunFTT keyword arguments:

from future_technology_transformation import RunFTT
model = RunFTT(
    inputs_path="/path/to/my/Inputs",
    utilities_path="/path/to/my/Utilities",
)

Functions

get_inputs_path()

Return the active Inputs directory as a Path.

get_utilities_path()

Return the active Utilities directory as a Path.

reset_paths()

Reset both path overrides to their defaults.

set_paths([inputs_path, utilities_path])

Set the data directories used by the model.