https://github.com/bcdev/doors-recipes

https://github.com/bcdev/doors-recipes

Science Score: 26.0%

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

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

Repository

Basic Info
  • Host: GitHub
  • Owner: bcdev
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 9.25 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 3 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License

README.md

Doors Recipes

This repository is dedicated to hosting the scripts/notebooks/files that are required in the scope of the DOORS project to create AR Data Cubes from data provided by project partners.

There are two folders in this repository: cubegen and docgen.

cubegen contains the functionality to create data cubes from the data provided by DOORS modelers. As this package is subject to change, it is versioned (see the changelog for differences between versions). For each model provisioner, there is a dedicated folder which contains a script named create-cube.py. Each script expects one mandatory and one optional parameter. The mandatory parameter is input-path: The path to where on your local computer the input data is stored (as xcube currently does not support accessing ftp data, this is so far the best solution to access the input data). The second parameter, output-path, allows you to specify an output folder on your local computer. If omitted, the resulting cube is written directly to the s3 bucket (this will only work though if you have valid AWS credentials stored on your computer). As many steps of the cube preparation are the same or similar for the various models, there is an utils-package doorsutils which contains functions that are used more than once.

docgen contains a single script that can create human-readable descriptions of the datasets stored in the s3 bucket. These descriptions may be used for documentation or in documents. This code has been tweaked from https://github.com/deepesdl/deepesdl-doc to also run on xarray datasets. The single parameter is an optional output path you might indicate to where the documents shall be written. If omitted, they are written to the docgen folder.

dockerimage contains a shell script and a dockerfile from which an image for a doors server can be built. It contains versions of xcube, xcube-cmems, geodb, geodb-places, and vdc-places. Always check the latest tag pushed to the quay.io and then increment the version tag for the new image by providing it as a script argument.

set ARG CACHE_ID=1 or any random number if you want to break the cache because you want fresh code from GitHub repo.

Owner

  • Name: Brockmann Consult Development
  • Login: bcdev
  • Kind: user
  • Location: Germany
  • Company: Brockmann Consult GmbH

GitHub Events

Total
  • Issues event: 2
  • Push event: 14
  • Pull request event: 1
  • Create event: 1
Last Year
  • Issues event: 2
  • Push event: 14
  • Pull request event: 1
  • Create event: 1

Dependencies

docs/requirements.txt pypi
  • mkapi ==1.0.14
  • mkdocs ==1.4.0