https://github.com/ssciwr/hydrosheds-cpp-api

A C++ interface to the HydroSHEDS data sets
https://github.com/ssciwr/hydrosheds-cpp-api

Last synced: 3 months ago
JSON representation

A C++ interface to the HydroSHEDS data sets

• Host: GitHub
• URL: https://github.com/ssciwr/hydrosheds-cpp-api
• Owner: ssciwr
• License: mit
• Created: 2021-04-20T12:07:39.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-19T19:31:52.000Z (almost 3 years ago)
• Last Synced: 2025-04-21T13:38:45.702Z (6 months ago)
• Language: C++
• Homepage:
• Size: 86.9 KB
• Stars: 0
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: COPYING.md

Awesome Lists containing this project

README

          
# Welcome to HydroSheds C++ API

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ssciwr/hydrosheds-cpp-api/ci.yml?branch=main)](https://github.com/dokempf/hydrosheds-cpp-api/actions/workflows/ci.yml)

[![Documentation Status](https://readthedocs.org/projects/hydrosheds-cpp-api/badge/)](https://hydrosheds-cpp-api.readthedocs.io/)

*This repository is currently under development. If you are interested in the result, check back in a few months.*

# Prerequisites

Building the HydroShed C++ API requires the following software installed:

* A C++11-compliant compiler

* CMake `>= 3.9`

* Doxygen (optional, documentation building is skipped if missing)

* [GDAL](https://gdal.org/), e.g. by doing

  *  `sudo apt install libgdal-dev` on Debian/Ubuntu

  *  `brew install gdal` on MacOS

# Building HydroSheds C++ API

The following sequence of commands downloads and builds HydroShed C++ API:

```

git clone --recursive https://github.com/ssciwr/hydrosheds-cpp-api.git

cd hydrosheds-cpp-api

mkdir build

cd build

cmake -DCMAKE_BUILD_TYPE=Release ..

make

```

The build process can be customized with the following CMake variables,

which can be set by adding `-D={ON, OFF}` to the `cmake` call:

* `BUILD_TESTING`: Enable building of the test suite (default: `ON`)

* `BUILD_DOCS`: Enable building the documentation (default: `ON`)

# Documentation

HydroShed C++ API provides a Sphinx-based documentation, that can

be browsed [online at readthedocs.org](https://hydrosheds-cpp-api.readthedocs.io).