Data

Tools

Indexes

Applications

Experiments

Open Source Science

st4sd-runtime-service

REST-API to create, start, and manage parameterised virtual experiment packages using ST4SD

https://github.com/st4sd/st4sd-runtime-service

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

Repository

REST-API to create, start, and manage parameterised virtual experiment packages using ST4SD

Basic Info
  • Host: GitHub
  • Owner: st4sd
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 790 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 10
Created over 3 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Runtime service for the Simulation Toolkit for Scientific Discovery (ST4SD)

Details

The st4sd-runtime-service container is deployed to OpenShift clusters using the ST4SD Deployment template. Access to the instantiated HTTPS service is handled using the OpenShift fork of the oauth-proxy side-car container. Users which have access to the Services objects in the same namespace as the st4sd-runtime-service microservice are authorized to access the microservice.

Runtime Service to create, manage, and monitor virtual experiments that execute using the st4sd-runtime-k8s and the st4sd-runtime-core.

The OpenAPI specification of the runtime service is in docs/openapi.yaml.

Quick links

Getting started

Requirements

Python

Running and developing this project requires a recent Python version, it is suggested to use Python 3.7 or above. You can find instructions on how to install Python on the official website.

Development

Coming soon.

Installing dependencies

Install the dependencies for this project with:

bash pip install -r requirements.txt

Developing locally

Coming soon.

Lint and fix files

Coming soon.

Help and Support

Please feel free to reach out to one of the maintainers listed in the MAINTAINERS.md page.

Contributing

We always welcome external contributions. Please see our guidance for details on how to do so.

References

If you use ST4SD in your projects, please consider citing the following:

bibtex @software{st4sd_2022, author = {Johnston, Michael A. and Vassiliadis, Vassilis and Pomponio, Alessandro and Pyzer-Knapp, Edward}, license = {Apache-2.0}, month = {12}, title = {{Simulation Toolkit for Scientific Discovery}}, url = {https://github.com/st4sd/st4sd-runtime-core}, year = {2022} }

License

This project is licensed under the Apache 2.0 license. Please see details here.

Owner

  • Name: ST4SD: Simulation Tookit for Scientific Discovery
  • Login: st4sd
  • 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
title: Simulation Toolkit for Scientific Discovery
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Michael A.
    family-names: Johnston
    affiliation: IBM Research
  - given-names: Vassilis
    family-names: Vassiliadis
    affiliation: IBM Research
  - given-names: Alessandro
    family-names: Pomponio
    affiliation: IBM Research
    orcid: 'https://orcid.org/0000-0003-1655-7500'
  - given-names: Edward
    family-names: Pyzer-Knapp
    affiliation: IBM Research
identifiers:
  - type: url
    value: 'https://github.com/st4sd/st4sd-runtime-core'
    description: ST4SD Runtime
repository-code: 'https://github.com/st4sd/st4sd-runtime-core'
url: 'https://st4sd.github.io/overview/'
keywords:
  - accelerated-discovery
  - simulation
  - toolkit
license: Apache-2.0
date-released: '2022-12-08'

GitHub Events

Total
  • Release event: 3
  • Push event: 9
  • Pull request review event: 1
  • Pull request event: 1
  • Create event: 3
Last Year
  • Release event: 3
  • Push event: 9
  • Pull request review event: 1
  • Pull request event: 1
  • Create event: 3

Dependencies

Dockerfile docker
  • $base_image latest build