Skip to content

c-hydro/shydata

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🗃️ SHYDATA – Versioned Datasets for SHYBOX

License Data Releases

SHYDATA is the official dataset repository for the SHYBOX hydrological processing framework.

It provides versioned, immutable, and reproducible datasets used by SHYBOX workflows in both operational and research contexts.


🔎 Overview

SHYDATA centralizes all environmental and hydrological datasets required by SHYBOX.

Key concepts:

  • Datasets are distributed only via GitHub releases
  • Each release represents a fixed dataset snapshot
  • Dataset versions are explicitly referenced by SHYBOX configurations
  • Repository history remains lightweight (no large binary data)

This approach guarantees traceability, reproducibility, and controlled updates.


🎯 Objectives

The main objectives of SHYDATA are to:

  • Provide centralized datasets for SHYBOX workflows
  • Ensure dataset versioning and long-term reproducibility
  • Enable controlled publication of dataset updates
  • Decouple dataset management from processing logic

📦 Dataset Philosophy

  • ❌ No datasets stored directly in the Git repository history
  • ✅ All datasets published as tagged releases
  • ✅ Each release corresponds to a single dataset version
  • ✅ Releases are immutable once published

📂 Repository Structure

shydata/
├── data/          # Recovered dataset content (created locally)
├── tools/         # Dataset recovery and release tools
├── docs/          # Dataset documentation
└── README.md

🚀 Dataset Recovery (Users)

git clone https://github.com/c-hydro/shydata.git
cd shydata

release_version=0.0.4
bash tools/shydata_recover_release.sh --version ${release_version} --dest .

📁 Recommended Workspace Layout

<workspace>/
├── shybox/
└── shydata/
    └── data/

🔗 Integration with SHYBOX

SHYDATA is designed to be used exclusively together with SHYBOX.

Refer to SHYBOX documentation: https://github.com/c-hydro/shybox


⚙️ Requirements

sudo apt-get install -y zstd

📜 License

This project is licensed under the
European Union Public License v1.2 (EUPL-1.2)


🔗 Related Repositories

Dataset releases

  • Dataset release 0.0.2 (2026-01-30T10:56:04+01:00) -> ./data/

Dataset releases

  • Dataset release 0.0.3 (2026-02-03T18:04:41+01:00) -> ./data/

Dataset releases

  • Dataset release 0.0.4 (2026-02-11T02:07:15+01:00) -> ./data/

About

❄️ 🌊 SHYDATA is the official versioned dataset repository for SHYBOX, providing reproducible, release-based data distribution and tools for managing hydrological and environmental datasets.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

Generated from c-hydro/template