st4sd-datastore
ST4SDs virtual-experiments metadata database
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.0%) to scientific vocabulary
Repository
ST4SDs virtual-experiments metadata database
Basic Info
Statistics
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
ST4SD Datastore
The ST4SD Datastore contains micro-services for:
- recording metadata about steps of virtual experiment instances
- support the retrieval of metadata, and files, associated with virtual experiment instances
There are 3 microservices and a daemon:
mongo_proxy.py: A rest-api for querying the database backend (e.g. MongoDB). It comes withlight logic for populating MongoDB documents with interfaces (https://st4sd.github.io/overview/using-a-virtual-experiment-interface).cluster_gateway.py: REST-API to serve files associated with virtual experiment instances.gateway_registry.py: REST-API that maintains a mapping ofreporter.py: A daemon that asynchronously pushes data from a virtual experiment run into a database backend (e.g MongoDB).
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
- 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: 2
- Pull request event: 2
- Create event: 3
Last Year
- Release event: 2
- Pull request event: 2
- Create event: 3
Dependencies
- $base_image latest build
- flask <=2.1.2
- flask-cors *
- flask-restx *
- gunicorn *
- pymongo *
- six *
- stream_zip *
- werkzeug <=2.1.2
- flask <=2.1.2
- flask-restx *
- pymongo *
- st4sd-runtime-core *
- stream_zip *