st4sd-deployment
Helm chart to deploy the Simulation Toolkit for Scientific Discovery on OpenShift
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
Repository
Helm chart to deploy the Simulation Toolkit for Scientific Discovery on OpenShift
Basic Info
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 18
Metadata Files
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
- Access to an OpenShift cluster with
cluster-adminpermissions- 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-adminpermissions, only permissions to modify objects in the namespace that holds the workflow stack.
- 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
- OpenShift command line tools (
ocv4.9+)- Instructions: https://docs.openshift.com/container-platform/4.9/cli_reference/openshift_cli/getting-started-cli.html
- Install stable version of
ocfrom https://mirror.openshift.com/pub/openshift-v4/clients/ocp/stable/ - It is good practice to periodically update your
occommand line utility to ensure that yourocbinary contains the latest patches and bug-fixes.
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
- Take a look at the troubleshooting-deployment guide to ensure that your workflow stack is properly instantiated.
- Get started with ST4SD.
- Test your ST4SD deployment using the st4sd-examples notebooks.
- Visit the ST4SD runtime service: at
${routePrefix}.{clusterRouteDomain}/rs>Note: Replace${key}with the value ofkeyin yourdeployment-options.yamlfile (the one that you created when following the requirements instructions).
Owner
- Name: ST4SD: Simulation Tookit for Scientific Discovery
- Login: st4sd
- Kind: organization
- Website: https://st4sd.github.io/overview/
- Repositories: 5
- Profile: https://github.com/st4sd
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