Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: LinhHo
  • License: apache-2.0
  • Language: Python
  • Default Branch: feature-full-rules
  • Size: 28.3 KB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 12 months ago · Last pushed 12 months ago
Metadata Files
Readme License Citation Authors

README.md

Area potentials

A modular snakemake workflow built for clio data modules.

Using this module

This module can be imported directly into any snakemake workflow. Please consult the integration example in tests/integration/Snakefile for more information.

Development

We use pixi as our package manager for development. Once installed, run the following to clone this repo and install all dependencies.

shell git clone git@github.com:calliope-project/module_area_potentials.git cd module_area_potentials pixi install --all

For testing, simply run:

shell pixi run test

To view the documentation locally, use:

shell pixi run serve-docs

To test a minimal example of a workflow using this module:

shell pixi shell # activate this project's environment cd tests/integration/ # navigate to the integration example snakemake --use-conda # run the workflow!

Data sources and licenses

  • GEDTM30 for slope
    • License: Creative Commons Attribution 4.0 International
  • GlobCover land cover data
    • License: "You may use the GlobCover land cover map for educational and/or scientific purposes, without any fee on the condition that you credit ESA and the Université Catholique de Louvain as the source of the GlobCover products."
  • GEBCO (General Bathymetric Chart of the Oceans) 15 arc-second data
    • License: "The GEBCO Grid is placed in the public domain and may be used free of charge. [...] Users must: Acknowledge the source of The GEBCO Grid. A suitable form of attribution is given in the documentation that accompanies The GEBCO Grid."
  • GHSL (Global Human Settlement Layer) built-up surface data (R2023, GHS-BUILT-S, 100m resolution)
    • License: "The GHSL has been produced by the EC JRC as open and free data. Reuse is authorised, provided the source is acknowledged."
  • WDPA (World Database on Protected Areas)
    • License: Non-commercial allowed. Citation: "UNEP-WCMC and IUCN (2025), Protected Planet: The World Database on Protected Areas (WDPA) and World Database on Other Effective Area-based Conservation Measures (WD-OECM) [Online], June 2025, Cambridge, UK: UNEP-WCMC and IUCN. Available at: www.protectedplanet.net."
  • Slope is derived from the GMTED2010 public-domain dataset and stored as unsigned 8-bit integers to save space, so we only have integer slope values.

Owner

  • Name: Linh Ho
  • Login: LinhHo
  • Kind: user

Citation (CITATION.cff)

# Citation file
# For more information, see:
# https://citation-file-format.github.io/
cff-version: 1.2.0
message: If you use this software or data produced by it, please cite it using the metadata from this file.
title: "clio - module_area_potentials: Area potentials"
repository: "https://github.com/calliope-project/module_area_potentials"
license: Apache-2.0
authors:
  - given-names: Linh
    family-names: Ho-Tran
  - given-names: Stefan
    family-names: Pfenninger-Lee

GitHub Events

Total
  • Push event: 4
  • Create event: 1
Last Year
  • Push event: 4
  • Create event: 1

Dependencies

.github/workflows/check-version.yml actions
.github/workflows/pr-ci.yml actions
.github/workflows/release.yml actions