{"id":13574658,"url":"https://github.com/seelabutk/substrate","last_synced_at":"2025-04-04T18:31:45.359Z","repository":{"id":37537532,"uuid":"453142649","full_name":"seelabutk/substrate","owner":"seelabutk","description":"Unified code base for Visualization as a Service (VaaS)","archived":false,"fork":false,"pushed_at":"2023-04-25T13:39:35.000Z","size":7815,"stargazers_count":3,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-24T12:04:01.918Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seelabutk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-01-28T16:41:18.000Z","updated_at":"2023-03-28T18:27:42.000Z","dependencies_parsed_at":"2024-01-14T04:07:49.738Z","dependency_job_id":null,"html_url":"https://github.com/seelabutk/substrate","commit_stats":{"total_commits":144,"total_committers":6,"mean_commits":24.0,"dds":"0.11805555555555558","last_synced_commit":"6602d0e04211a2b676d4be81cd0e04cd05074673"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seelabutk%2Fsubstrate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seelabutk%2Fsubstrate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seelabutk%2Fsubstrate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seelabutk%2Fsubstrate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seelabutk","download_url":"https://codeload.github.com/seelabutk/substrate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247229512,"owners_count":20905064,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:00:53.469Z","updated_at":"2025-04-04T18:31:45.047Z","avatar_url":"https://github.com/seelabutk.png","language":"Python","funding_links":[],"categories":["Table of Contents","Projects"],"sub_categories":["Data Visualization and Rendering","Others"],"readme":"# Substrate\n\nSubstrate is a tool that allows you to automate the process of deploying visualization tools to different computing environments.\n\n### Supported Visualization tools\n\n- NetCDF Slicer\n- [OSPRay Studio](https://github.com/ospray/ospray_studio)\n- [Volume Rendering via Tapestry](https://github.com/seelabutk/tapestry)\n- [Flow Visualization via Braid](https://bitbucket.org/seelabutk/vci)\n\n### Supported Environments\n\nAny computing environment capable of running [Docker Swarm](https://docs.docker.com/engine/swarm/) is a valid deployment target.\n\n### Requirements\n\n- [Python 3.7 or later](https://www.python.org/downloads/).\n\nThis tool relies upon Docker Swarm. In order for it to work, the following assumptions are made of each compute node (for AWS deployments, these requirements are handled automatically):\n\n- [Docker Engine](https://docs.docker.com/engine/) must be installed.\n- The ports needed by Docker Swarm must be open for communication between nodes. Please review the [Docker Swarm docs](https://docs.docker.com/engine/swarm/) for more information.\n- You must be able to connect to each node over SSH with a private key available in `~/.ssh`.\n\n### Getting Started\n\nTo install run\n\n\tpip install seelabutk-substrate\n\nthen launch a visualization tool via a CLI using\n\n\tsubstrate 'tool_name' start\n\tsubstrate 'tool_name' stop\n\nor via Python using\n\n\tfrom substrate import Substrate\n\n\tstack = Substrate('tool_name')\n\tstack.start()\n\tstack.stop()\n\nValid tool names:\n- hello_world (this will just host the provided data sources as static files)\n- nc_slicer\n- ospray_studio\n- tapestry\n- braid\n\n### Configuration\n\nSubstrate is configured using `substrate.config.yaml`. The tool will look for this file starting in your current working directory then look for it in parent folders. You can also provide a path with\n\n\tsubstrate tapestry start -f /path/to/substrate.config.yaml\n\nor\n\n\tstack = Substrate('tool_name', {}, path='path/to/substrate.config.yaml')\n\nYou may also specify the config directly via JSON/a dictionary with\n\n\tsubstrate tapestry start -c \"{ config here... }\"\n\nor\n\n\tstack = Substrate('tool_name', config)\n\nThe options for the configuration file can be found [here](api/substrate.config.yaml).\n\nEach tool has static files that are needed to run it. Defaults are provided, but if needed or desired they can be modified. Here are links to get the default files for [Tapestry](src/substrate/tapestry) and [Braid](src/substrate/vci).\n\nFor more information on configuring each tool, please refer to each tools documentation:\n- NetCDF Slicer: coming soon\n- [OSPRay Studio](https://github.com/ospray/ospray_studio)\n- [Tapestry](https://github.com/seelabutk/tapestry)\n- [Braid](https://bitbucket.org/seelabutk/vci)\n\n### Development Environment\n\nTo setup the dev environment, please install [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/index.html). Once installed, run the following commands to set up the development environment:\n\n\tpipenv --python /path/to/your/python3.10\n\tpipenv sync -d\n\tpipenv shell\n\n### Uploading to PyPI\n\nTo upload to prepare a new release, run the following commands:\n\n\tpython -m build\n\tpython -m twine upload dist/*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseelabutk%2Fsubstrate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseelabutk%2Fsubstrate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseelabutk%2Fsubstrate/lists"}