st4sd-deployment

Helm chart to deploy the Simulation Toolkit for Scientific Discovery on OpenShift

https://github.com/st4sd/st4sd-deployment

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

Repository

Helm chart to deploy the Simulation Toolkit for Scientific Discovery on OpenShift

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

README.md

Simulation Toolkit for Scientific Discovery (ST4SD)

Details

This repository contains the deployment files and instructions for installing the Simulation Toolkit For Scientific Discovery (ST4SD).

Quick links

Getting started

We currently support installing the ST4SD stack via helm.

Requirements

  1. Access to an OpenShift cluster with cluster-admin permissions
    • Required for creation of a kubernetes objects (such as CustomResourceDefinition and Role Based Access Control (RBAC)). Regular updates to the workflow stack do not require cluster-admin permissions, only permissions to modify objects in the namespace that holds the workflow stack.
  2. OpenShift command line tools (oc v4.9+)

Development

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.

After installing the toolkit

  1. Take a look at the troubleshooting-deployment guide to ensure that your workflow stack is properly instantiated.
  2. Get started with ST4SD.
  3. Test your ST4SD deployment using the st4sd-examples notebooks.
  4. Visit the ST4SD runtime service: at ${routePrefix}.{clusterRouteDomain}/rs >Note: Replace ${key} with the value of key in your deployment-options.yaml file (the one that you created when following the requirements instructions).

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: 2
  • Create event: 3
Last Year
  • Release event: 3
  • Push event: 2
  • Create event: 3