Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# CODEOWNERS — automatically request reviews for matching paths

# Global owner — reviews all PRs by default
* @Goldokpa

# GitHub config and workflows
/.github/ @Goldokpa

# ML models and training
/src/climatevision/models/ @Goldokpa
/src/climatevision/training/ @Goldokpa

# API, frontend, docs
/src/climatevision/api/ @Goldokpa
/frontend/ @Goldokpa
/docs/ @Goldokpa
26 changes: 26 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
version: 2
updates:
# Python dependencies (pip)
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 10
reviewers:
- "Goldokpa"

# GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
reviewers:
- "Goldokpa"

# Node / npm (frontend)
- package-ecosystem: "npm"
directory: "/frontend"
schedule:
interval: "weekly"
reviewers:
- "Goldokpa"
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Summary

<!-- Briefly describe what this PR does and why. -->

## Related Issue

Closes #

## Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
- [ ] Refactor / code cleanup
- [ ] CI / build / tooling change

## Key Changes

<!-- List the main changes made. -->

## Testing

- [ ] Unit tests pass locally (`pytest tests/`)
- [ ] Manual API test (curl / OpenAPI docs)
- [ ] Frontend smoke test (`npm run dev`)
- [ ] New tests added for this change

## Checklist

- [ ] Code follows project style (black/ruff for Python, eslint for frontend)
- [ ] Self-review completed
- [ ] Documentation updated where needed
- [ ] PR targets the `develop` branch (not `main`)
58 changes: 58 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Changelog

All notable changes to ClimateVision will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

---

## [Unreleased]

### Added
- SECURITY.md — private vulnerability reporting via GitHub Security Advisories
- CODEOWNERS — automatic review assignment to @Goldokpa
- Pull request template for structured contributor guidance
- Dependabot configuration for pip, npm, and GitHub Actions updates
- CHANGELOG.md (this file)
- CITATION.cff for GitHub "Cite this repository" button

### Changed
- CODE_OF_CONDUCT.md — replaced placeholder email with GitHub private reporting link

### Removed
- SETUP_COMPLETE.md — internal artifact moved out of public repo
- team_docs/ — internal role documents moved out of public repo

---

## [0.2.0] — 2026-03-04

### Added
- FastAPI REST backend with paginated run history and stats endpoint
- React dashboard with interactive bbox map, Recharts analytics, and confidence gauges
- U-Net semantic segmentation for deforestation and arctic ice detection
- Siamese network change detection
- Google Earth Engine integration with cloud masking and 256×256 tiling
- MLflow experiment tracking
- ONNX model export
- Flood detection analysis type
- NGO management — organisation registration, region subscriptions, email/webhook alerts
- Full OpenAPI docs at `/docs`

### Changed
- README rewritten to concise FastAPI-style format

---

## [0.1.0] — 2026-03-04

### Added
- Initial repository structure and governance files
- Basic project scaffold (src layout, config, notebooks, scripts)
- MIT License
- Contributing guide and Code of Conduct

[Unreleased]: https://github.com/Climate-Vision/ClimateVision/compare/v0.2.0...HEAD
[0.2.0]: https://github.com/Climate-Vision/ClimateVision/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/Climate-Vision/ClimateVision/releases/tag/v0.1.0
29 changes: 29 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
cff-version: 1.2.0
message: "If you use ClimateVision in your research, please cite it using this file."
type: software
title: "ClimateVision: Open-Source AI Platform for Environmental Monitoring"
version: "0.2.0"
date-released: "2026-03-04"
url: "https://github.com/Climate-Vision/ClimateVision"
repository-code: "https://github.com/Climate-Vision/ClimateVision"
license: MIT
abstract: >
ClimateVision is an open-source machine learning platform that detects
environmental change from satellite imagery. It uses deep learning
(U-Net, Siamese networks) to monitor deforestation, arctic ice melting,
and flooding, giving conservation NGOs and researchers automated alerts
without manual analysis. Built on Sentinel-2 and Landsat data via
Google Earth Engine, it runs as a REST API with a React dashboard.
keywords:
- climate
- machine-learning
- satellite-imagery
- deep-learning
- remote-sensing
- deforestation
- google-earth-engine
- fastapi
- u-net
authors:
- name: "ClimateVision Contributors"
website: "https://github.com/Climate-Vision"
78 changes: 1 addition & 77 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,77 +1 @@
# Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at:

- #email

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code
# Code of Conduct## Our PledgeWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.## Our StandardsExamples of behavior that contributes to a positive environment for our community include:- Demonstrating empathy and kindness toward other people- Being respectful of differing opinions, viewpoints, and experiences- Giving and gracefully accepting constructive feedback- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience- Focusing on what is best not just for us as individuals, but for the overall communityExamples of unacceptable behavior include:- The use of sexualized language or imagery, and sexual attention or advances of any kind- Trolling, insulting or derogatory comments, and personal or political attacks- Public or private harassment- Publishing others' private information, such as a physical or email address, without their explicit permission- Other conduct which could reasonably be considered inappropriate in a professional setting## Enforcement ResponsibilitiesCommunity leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.## ScopeThis Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.## EnforcementInstances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement by opening a [GitHub Security Advisory](https://github.com/Climate-Vision/ClimateVision/security/advisories/new) in this repository.All complaints will be reviewed and investigated promptly and fairly.All community leaders are obligated to respect the privacy and security of the reporter of any incident.## Enforcement GuidelinesCommunity leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:### 1. Correction**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
43 changes: 43 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Security Policy

## Supported Versions

ClimateVision is under active development. Security fixes are applied to the latest release on the `main` branch.

| Version | Supported |
| ------- | ------------------ |
| 0.2.x | :white_check_mark: |
| < 0.2 | :x: |

## Reporting a Vulnerability

**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**

Instead, please report them privately using GitHub's built-in Security Advisory system:

- Go to the [Security tab](https://github.com/Climate-Vision/ClimateVision/security) of this repository.
- Click **"Report a vulnerability"**.
- Fill out the form with a description of the issue, steps to reproduce, and (if known) a suggested fix.

You should receive an initial response within **5 business days**. If the issue is confirmed, we will work on a fix and coordinate disclosure with you.

## Scope

**In scope:**

- Vulnerabilities in the ClimateVision API (`src/climatevision/api/`)
- Vulnerabilities in the React dashboard (`frontend/`)
- Vulnerabilities in the data pipeline, model inference, or authentication flow
- Dependency vulnerabilities not already tracked by Dependabot

**Out of scope:**

- Issues in third-party services (Google Earth Engine, MLflow, etc.) — please report those upstream
- Self-inflicted issues from running with debug or development configuration in production
- Missing security best-practices without a demonstrated exploit

## Disclosure Policy

We follow a coordinated disclosure model. After a fix is released, we will publish a GitHub Security Advisory crediting the reporter (unless anonymity is requested).

Thank you for helping keep ClimateVision and its users safe.
Loading