Skip to main content

SGCI resource catalog API

Project description

Floatview Stats

Latest Release
PyPI Downloads

#Introduction to SCGI Inventory

Version

This is version 1.0.0 of the SGCI Resource Description Specification schema. This work is released under an Apache 2.0 license <https://raw.githubusercontent.com/SGCI/sgci-resource-inventory/master/LICENSE>_ .

Introduction

The user-facing components of the Cyberinfrastructure (CI) ecosystem, science gateways and scientific workflow systems, share a common need of interfacing with physical resources (storage systems and execution environments) to manage data and execute codes (applications).

However, there is no uniform, platform-independent way to describe either the resources or the applications. To address this, we propose uniform semantics for describing resources and applications that will be relevant to a diverse set of stakeholders.

The SGCI Resource Description Specification provides a standard way for institutions and service providers to describe storage and computing infrastructure broadly available to the research computing and science gateway community. SGCI Resource descriptions provide a foundation for interoperability across gateway components and other cyberinfrastructure software.

The current, initial version of the resource description language focuses on “traditional” HPC and high-throughput storage and computing resources

Installation

pip install sgci-resource

Usage

from sgci_resource import core
gh = core.SCGICatalogXsede() 
#gh = core.SCGICatalogLocal(folder="REPO_PATH")
#gh = core.SCGICatalogGithub(token="GITHUB_TOKEN")



#print available resources
l = gh.listResources()
print(l)


# Print json description
resource = gh.getResource('RESOURCE.IDENTIFICATION.KEY') # e.g. stampede2.tacc.xsede
print(resource)

# Print json description
namehost = gh.searchPath("[name, host]", resource)
print(namehost)

#Integration

Integration projects

The SCGI Inventory is currently been integrated with Airavata, HUBzero |reg| , and Tapis. We expect the inventory to be adapted by others soon.

Links:

https://github.com/SGCI/sgci-resource-inventory

https://github.com/SGCI/sgci-resource-inventory-cache-service

Get Involved!

Issues, Comments, PRs all welcome!

SGCI: help@sciencegateways.org

Email: jstubbs at tacc.utexas.edu, smarru at iu.edu, dmejiapa at purdue.edu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sgci-resource-0.0.1.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

sgci_resource-0.0.1-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file sgci-resource-0.0.1.tar.gz.

File metadata

  • Download URL: sgci-resource-0.0.1.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sgci-resource-0.0.1.tar.gz
Algorithm Hash digest
SHA256 bd68b6947819687c662a92d197f3cb06c22f0693fb4824fb36c8e826af4c2746
MD5 bcde983f0d778be87f424d60c2d41fc0
BLAKE2b-256 0a1bdc6731b5bbd1c241fe0e61f8b748227d0b29aa6918f5ff45cac2bcfd0115

See more details on using hashes here.

File details

Details for the file sgci_resource-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: sgci_resource-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sgci_resource-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8d03e0bc7f4b602ade1a3dcfa7e8b246d72db20c191af16eade39ef7374e5fdd
MD5 27259e33805aa74f23d799e62dc4633b
BLAKE2b-256 13c63ca0ad0401081b5de81fce378634c47b40c95a0fd814349c9d6db37b2574

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page