Data

Tools

Indexes

Applications

Experiments

Open Source Science

skope-api

SKOPE backend services for dataset metadata and timeseries data

https://github.com/openskope/skope-api

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

Repository

SKOPE backend services for dataset metadata and timeseries data

Basic Info
Statistics
  • Stars: 2
  • Watchers: 6
  • Forks: 1
  • Open Issues: 16
  • Releases: 3
Created about 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

skope-api

DOI skope-api build

Backend services for dataset metadata and timeseries data extracted from SKOPE datasets - see https://api.openskope.org/docs for API details and examples

Project Setup

Dataset Metadata

Dataset metadata currently needs to be specified twice and should :

  • timeseries/metadata.yml contains the full dataset metadata exposed by the metadata endpoint and consumed by the skopeui app
  • timeseries/deploy/metadata/prod.yml contains a subset of the dataset metadata used by the backend services to handle timeseries extraction (time ranges, time resolution, and available variables) from the datacubes available in the store (runtime settings for the store dynamically generated at build time at timeseries/deploy/settings/config.yml)

Development

Set up dev configuration

bash ./configure dev

Build the project & run the backend server and geoserver

bash make deploy

Try out the analysis endpoint

bash http --json POST localhost:8002/datasets/yearly < yearly.json http --json POST localhost:8002/datasets/monthly < monthly.json

Run the tests

bash make test

Production

Set up for prod deployment

bash ./configure prod

build & deploy

bash make deploy

Owner

  • Name: SKOPE - Synthesizing Knowledge of Past Environments
  • Login: openskope
  • Kind: organization

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
message: "If you use the SKOPE application, please cite it as below."
authors:
- family-names: "Bocinsky"
  given-names: "Kyle"  
  orcid: "https://orcid.org/0000-0003-1862-3428"
- family-names: "Gillreath-Brown"
  given-names: "Andrew" 
  orcid: "https://orcid.org/0000-0002-2272-5542"
- family-names: "Kintigh"
  given-names: "Keith"
  orcid: "https://orcid.org/0000-0001-9821-3634"
- family-names: "Kinzig"
  given-names: "Ann"
- family-names: "Kohler"
  given-names: "Tim"
  orcid: "https://orcid.org/0000-0002-3414-6660"
- family-names: "Lee"
  given-names: "Allen"
  orcid: "https://orcid.org/0000-0002-6523-6079"
- family-names: "Ludäscher"
  given-names: "Bertram"
  orcid: "https://orcid.org/0000-0001-9140-936X"
- family-names: "McPhillips"
  given-names: "Timothy"
- family-names: "Nguyễn"
  given-names: "Christine"    
- family-names: "Pritchard"
  given-names: "Calvin"
  orcid: "https://orcid.org/0000-0002-4557-8602"  
title: "Synthesizing Knowledge of Past Environments (SKOPE) Web Application"
doi: "10.5281/zenodo.6522961"
abstract: >
  SKOPE (Synthesizing Knowledge of Past Environments) is an online resource for paleoenvironmental data and models. It enables scholars to easily discover, explore, visualize, and synthesize knowledge of environments in the recent or remote past. Given a location and temporal interval, SKOPE offers access to diverse sources of long-term, high-resolution environmental data. SKOPE builds on vast amounts of prior data collection and previous research, transforming those into readily usable environmental knowledge.

  This repository contains the SKOPE API backend (https://api.openskope.org/docs) used to serve the dataset metadata, timeseries data, and summary statistics available in the SKOPE user interface (https://app.openskope.org with code at https://github.com/openskope/skopeui).
  
  The initial prototype of the SKOPE application was developed with contributions from Adam Brin, Johnathan Rush, Sarah Oas, Jeffrey Terstriep, Xingchen Hong, and Shaowen Wang.
repository-code: 'https://github.com/openskope/skope-api'
url: 'https://www.openskope.org'
repository: 'https://github.com/openskope/skope-api'
keywords:
  - environmental data
  - precipitation
  - palmer drought severity index (pdsi)
  - paleocar
  - lbda
  - srtm
license: MIT
version: v2022.06
date-released: '2022-06-06'

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Dependencies

timeseries/deploy/requirements/base.txt pypi
  • PyYAML ==6.0
  • Shapely ==1.7.1
  • fastapi ==0.75.1
  • geojson_pydantic ==0.3.3
  • numba ==0.55.1
  • pandas ==1.4.2
  • pydantic ==1.9.0
  • pyproj ==3.3.0
  • python-dateutil ==2.8.2
  • rasterio ==1.2.10
  • scipy ==1.8.0
  • sentry-sdk ==1.5.11
  • uvicorn ==0.17.6
timeseries/deploy/requirements/dev.txt pypi
  • black * development
  • httpx * development
  • ipython * development
  • pytest * development
  • pytest-asyncio * development
  • requests * development
timeseries/deploy/requirements/prod.txt pypi
  • gunicorn >=20
  • httptools >=0.1
  • uvloop >=0.15
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2 composite
  • actions/setup-python v2 composite
timeseries/deploy/Dockerfile docker
  • python 3.10 build