// readme

Kausal Paths

Kausal Paths is a tool for predicting the future emissions of cities based on historical emission data and various climate actions. Users can compare how emissions develop in different scenarios. Data is provided using a GraphQL API.

Installation

Prerequisites

Make sure you have installed the following:

  • a package manager (e.g., homebrew for macOS, apt for Ubuntu, etc.)
  • git
  • python
  • uv (python package manager)
  • direnv (auto-loads environment variables) - Beginner Hints: before direnv works you need to hook it into your shell: depending on which shell you’re using (find out with echo $SHELL) add eval "$(direnv hook bash)" to your ~/.bashrc OR eval "$(direnv hook zsh)" to your ~/.zshrc (create those files if they don’t exist yet). After that, restart the terminal or run source ~/.bashrc OR source ~/.zshrc.

Development

After cloning the repository, initialize the required shared-code submodule:

git submodule update --init kausal_common

The mise configuration shared with Kausal Watch is provided by that submodule through the symlinks in mise/.

Then move to your project root directory (paths…