Data

Tools

Indexes

Applications

Experiments

Open Source Science

stgrid2area

Uses the stgrid2area package to clip and aggregate different spatiotemporal data sources to (catchment) areas.

https://github.com/camels-de/stgrid2area-workflows

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 (9.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Uses the stgrid2area package to clip and aggregate different spatiotemporal data sources to (catchment) areas.

Basic Info
  • Host: GitHub
  • Owner: CAMELS-DE
  • License: cc0-1.0
  • Language: Python
  • Default Branch: main
  • Size: 80.1 KB
Statistics
  • Stars: 0
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created almost 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

stgrid2area-workflows

Uses the stgrid2area package to clip and aggregate different spatiotemporal data sources to (catchment) areas.

How generic?

/ |- in/ | |- parameters.json |- out/ | |- ... |- src/ | |- tool.yml | |- run.py

  • parameters.json are parameters. Whichever framework runs the container, this is how parameters are passed.
  • tool.yml is the tool specification. It contains metadata about the scope of the tool, the number of endpoints (functions) and their parameters
  • run.py is the tool itself, or a Python script that handles the execution. It has to capture all outputs and either print them to console or create files in /out

How to build the image?

You can build the image from within the root of this repo by docker build -t stgrid2area-workflows .

Alternatively, the contained .github/workflows/docker-image.yml will build the image for you on new releases on Github. You need to change the target repository in the aforementioned yaml.

How to run?

This template installs the json2args python package to parse the parameters in the /in/parameters.json. This assumes that the files are not renamed and not moved and there is actually only one tool in the container. For any other case, the environment variables PARAM_FILE can be used to specify a new location for the parameters.json and TOOL_RUN can be used to specify the tool to be executed. The run.py has to take care of that.

To invoke the docker container directly run something similar to: docker run --rm -it -v /path/to/local/in:/in -v /path/to/local/out:/out -e TOOL_RUN=eobs stgrid2area-workflows

  1. change the run.py to consume parameters and data from /in and useful output in out
  2. build, run, rock!

Owner

  • Name: CAMELS-DE
  • Login: CAMELS-DE
  • Kind: organization
  • Location: Germany

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stgrid2area-workflows
type: software
authors:
  - given-names: Alexander
    family-names: Dolich
    email: alexander.dolich@kit.edu
    affiliation: >-
      Institute for Water and Environment, Hydrology,
      Karlsruhe Institute for Technology (KIT)
    orcid: "https://orcid.org/0000-0003-4160-6765"
repository-code: "https://github.com/VForWaTer/stgrid2area-workflows"
url: "https://vforwater.github.io/tool-specs/"
abstract: >-
  Uses the stgrid2area package to clip and aggregate different spatiotemporal data sources to (catchment) areas.
keywords:
  - docker
  - tool-spec
  - raster
  - spatio-temporal
  - aggregation
  - catchment
  - clipping
license: CC-BY-4.0
version: "0.1"
date-released: "2024-09-05"

GitHub Events

Total
  • Push event: 22
  • Create event: 3
Last Year
  • Push event: 22
  • Create event: 3

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 55 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 16
  • Total maintainers: 1
pypi.org: stgrid2area

Extract and aggregate spatio-temporal data to a specified area.

  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 55 Last month
Rankings
Dependent packages count: 10.4%
Average: 34.4%
Dependent repos count: 58.5%
Maintainers (1)
AlexDo1
Last synced: 10 months ago

Dependencies

.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
  • softprops/action-gh-release v1 composite
Dockerfile docker
  • python 3.11 build