Tempelhof Climate
Table of Contents
- Project Overview
- Prerequisites
- Project Architecture
- Data Sources
- Installation
- Authentication
- Linting and Formatting
- Sponsors
- License
Project Overview
Tempelhof Climate Change Analysis is a collaborative project by the CODE University software engineering group aimed at observing climate changes occurring at Tempelhof Feld by analyzing satellite images.
Prerequisites
- Python 3.x
- Node.js, npm/yarn
- Git
Project Architecture
Data Sources
Installation
Backend Installation
- Clone the repository:
git clone https://github.com/codeuniversity/thf-climate.git
- Change directory to backend (from thf-climate):
- Create a virtual environment and install the dependencies:
python -m venv venv source venv/bin/activate pip install -r requirements-dev.txt - Copy the env.sample file to .env and set the required variables:
Frontend Installation
- Change directory to frontend (from thf-climate):
- Install NPM packages:
- Run project locally:
Docker Installation
- Clone the repository:
git clone https://github.com/codeuniversity/thf-climate.git
- Build the Docker image:
docker build --tag thf-climate . - Run the Docker Container:
docker run --publish 8000:8000 thf-climate
Running the API
Run the API locally using:
Serving at: http://127.0.0.1:8000 API docs: http://127.0.0.1:8000/docs
Authentication
You need to authenticate with GEE to run the code. This is done with the auth.py script.
If you have authenticated before, you will most likely find your credentials in the following files. Add those credentials to your .env, then run the command above.
Linux/ Mac:
$HOME/.config/earthengine/credentials
Windows:
%UserProfile%\.config\earthengine\credentials
Linting and Formatting
Ruff is used for linting and formatting.
You can install the vscode extension for ruff to get linting and formatting on save here
Sponsors
- CODE University
- Google Earth Engine
License
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.
