Data

Tools

Indexes

Applications

Experiments

Open Source Science

metacatalog_aggregator

Aggregates standard data formats contextualized from MetaCatalog into a GeoCube

https://github.com/vforwater/metacatalog_aggregator

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

Repository

Aggregates standard data formats contextualized from MetaCatalog into a GeoCube

Basic Info
  • Host: GitHub
  • Owner: VForWaTer
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 20.5 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Metacatalog aggregator

This tool is designed to be used together with the V-FOR-WaTer Metacatalog data loader. It uses a number of data source files along with either a metacatalog entry or JSON dumps of the metadata. The data is aggregated to a target precision (temporal) and spatial resolution and then ingested into a geocube that is stored as a netCDF file.

This tool is based on the Python template for a generic containerized Python tool following the Tool Specification for reusable research software using Docker.

Structure

/ |- in/ | |- input.json |- out/ | |- ... |- src/ | |- tool.yml | |- run.py | |- CITATON.cff

  • input.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
  • CITATION.cff is a citation file that describes the tool and its authors. It is used by the

How to build the image?

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

How to run?

This template installs the json2args python package to parse the parameters in the /in/input.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=geocube metacatalog_geocube

Then, the output will be in your local out and based on your local input folder. Stdout and Stderr are also connected to the host.

Owner

  • Name: V-FOR-WaTer
  • Login: VForWaTer
  • Kind: organization

V-FOR-WaTer

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Metacatalog GeoCube aggregator
message: >-
  Data Cude generator from contenxtualized MetaCatalog input data
type: software
authors:
  - given-names: Mirko
    family-names: Mälicke
    email: mirko.maelicke@KIT.edu
    affiliation: >-
      Institute for Water and Environment, Hydrology,
      Karlsruhe Institute for Technology (KIT)
    orcid: 'https://orcid.org/0000-0002-0424-2651'
repository-code: 'https://github.com/hydrocode-de/metacatalog_aggregator'
abstract: >-
  This tool is designed to be used together with the V-FOR-WaTer Metacatalog data loader.
  It uses a number of data source files along with either a metacatalog entry or JSON dumps
  of the metadata.
  The data is aggregated to a target precision (temporal) and spatial resolution and then
  ingested into a geocube that is stored as a netCDF file.

keywords:
  - docker
  - tool-spec
  - V-For-WaTer
  - MetaCatalog
  - netCDF
  - DataCube
  - open data cube
license: MIT
version: '0.1'
date-released: '2024-08-20'

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

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.12.2 build