Data

Tools

Indexes

Applications

Experiments

Open Source Science

module_geo_boundaries

A module to create arbitrary regional boundary datasets for energy systems modelling

https://github.com/calliope-project/module_geo_boundaries

Science Score: 54.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
    Links to: aps.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A module to create arbitrary regional boundary datasets for energy systems modelling

Basic Info
  • Host: GitHub
  • Owner: calliope-project
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 310 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 1
  • Releases: 5
Created 12 months ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Authors

README.md

clio - Geo-boundaries module

A data module to create arbitrary regional boundaries for energy systems modelling.

Example of European shapes

A modular snakemake workflow built for clio data modules.

Steps

  1. Data is downloaded and harmonized using a common schema.
  2. Country area is clipped using the marine regions to accurately approximate their landmass.
  3. The marine data and the clipped land mass data are combined following the schema. Contested EEZ's (e.g., Taiwan, Falkland islands) are removed during this step.

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_geo_boundaries.git cd module_geo_boundaries pixi install --all

For testing, simply run:

shell pixi run test-integration

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 --cores 2 # run the workflow!

Owner

  • Name: Calliope
  • Login: calliope-project
  • Kind: organization

A multi-scale energy systems modelling framework

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_geo_boundaries"
repository: "https://github.com/calliope-project/module_geo_boundaries"
license: Apache-2.0
authors:
  - given-names: Ivan
    family-names: Ruiz Manuel
    orcid: "0000-0003-2288-6423"

GitHub Events

Total
  • Create event: 12
  • Release event: 5
  • Issues event: 20
  • Delete event: 11
  • Issue comment event: 5
  • Public event: 1
  • Push event: 48
  • Pull request event: 20
  • Pull request review event: 30
  • Pull request review comment event: 29
Last Year
  • Create event: 12
  • Release event: 5
  • Issues event: 20
  • Delete event: 11
  • Issue comment event: 5
  • Public event: 1
  • Push event: 48
  • Pull request event: 20
  • Pull request review event: 30
  • Pull request review comment event: 29

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 13
  • Total pull requests: 13
  • Average time to close issues: 5 days
  • Average time to close pull requests: 5 days
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 0.15
  • Average comments per pull request: 0.15
  • Merged pull requests: 7
  • Bot issues: 7
  • Bot pull requests: 6
Past Year
  • Issues: 13
  • Pull requests: 13
  • Average time to close issues: 5 days
  • Average time to close pull requests: 5 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 0.15
  • Average comments per pull request: 0.15
  • Merged pull requests: 7
  • Bot issues: 7
  • Bot pull requests: 6
View more stats
Top Authors
Issue Authors
  • github-actions[bot] (7)
  • irm-codebase (5)
  • brynpickering (1)
Pull Request Authors
  • pre-commit-ci[bot] (6)
  • irm-codebase (6)
  • sjpfenninger (1)
Top Labels
Issue Labels
bug (5) enhancement (1)
Pull Request Labels

Dependencies

.github/workflows/check-latest-template-spec.yml actions
.github/workflows/pr-ci.yml actions
  • actions/checkout v4 composite
  • prefix-dev/setup-pixi v0.8.3 composite