Skip to content

OGuggenbuehl/ClimateFinanceBERT-UI

Repository files navigation

ClimateFinanceBERT-UI

TUM Think Tank Logo

Climate Finance Analysis & Visualization Platform

An interactive dashboard for exploring and analyzing global climate finance data powered by the ClimateFinanceBERT model as described in Toetzke, M., Stünzi, A. & Egli, F. (2022).

📊 Features

  • Interactive Map Visualization: View global climate finance flows
  • Data Analysis Tools: Country statistics and detailed breakdowns by year range, categories, and flow types
  • Export Capabilities: Download data as queried from the dashboard
  • User-Friendly Interface: Built with Dash and Plotly for an intuitive user experience

🚀 Getting Started

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/OGuggenbuehl/ClimateFinanceBERT-UI.git
cd ClimateFinanceBERT-UI

There is a host of convenient Make-commands to navigate the project. You can view all available commands by running:

make help
  1. Install dependencies using the provided Makefile:
make install

This will:

  • Install uv package manager
  • Create a virtual environment
  • Install dependencies as defined in pyproject.toml
  • Set up direnv for environment management
  1. Prepare the database from the raw CSV data using the DuckDB pipeline:
make duckdb-pipeline

For more details on the pipeline, see the DuckDB Pipeline documentation.

Running the Application

Start the application locally:

make run

For development with automatic code formatting and linting:

make dev

The application will be available at http://localhost:8050.

Using Docker

Several Docker commands are available:

# Build application image and run container in detached mode
make docker-up

# Stop detached container
make docker-down

# Build application image
make docker-build

# Build the application image in development mode
make docker-dev

# View logs
make docker-logs

You can customize the port by setting the PORT environment variable:

PORT=8051 make docker-up

🏗️ Project Structure

ClimateFinanceBERT-UI/
├── data/               # Data files
├── docker/             # Docker configuration
├── notebooks/          # Jupyter notebooks for exploration
└── src/                # Source code
    ├── app.py          # Application entry point
    ├── assets/         # CSS, fonts, and static assets
    ├── callbacks/      # Dash callback functions
    ├── components/     # UI components and widgets
    ├── pages/          # Application page layouts
    └── utils/          # Utility functions and helpers

📝 License

MIT License

👥 Contributors

  • Oliver Guggenbühl

🙏 Acknowledgements

  • The ClimateFinanceBERT model and research team
    • Anna Stünzi - Universität St. Gallen
    • Florian Egli - TUM Think Tank
    • Malte Toetzke - TUM Think Tank
  • TUM Think Tank for supporting the project
  • Country boundary data from Natural Earth (Public Domain)
    • Using Natural Earth 1:50m Admin 0 Countries dataset (242 countries/territories)

About

An interactive dashboard to access the research findings of the ClimateFinanceBERT project

Resources

License

Stars

Watchers

Forks

Packages

No packages published