Substrate
Substrate is a tool that allows you to automate the process of deploying visualization tools to different computing environments.
Supported Visualization tools
Supported Environments
Any computing environment capable of running Docker Swarm is a valid deployment target.
Requirements
This 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):
- Docker Engine must be installed.
- The ports needed by Docker Swarm must be open for communication between nodes. Please review the Docker Swarm docs for more information.
- You must be able to connect to each node over SSH with a private key available in
~/.ssh.
Getting Started
To install run
pip install seelabutk-substrate
then launch a visualization tool via a CLI using
substrate 'tool_name' start
substrate 'tool_name' stop
or via Python using
from substrate import Substrate
stack = Substrate('tool_name')
stack.start()
stack.stop()
Valid tool names:
- hello_world (this will just host the provided data sources as static files)
- nc_slicer
- ospray_studio
- tapestry
- braid
Configuration
Substrate 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
substrate tapestry start -f /path/to/substrate.config.yaml
or
stack = Substrate('tool_name', {}, path='path/to/substrate.config.yaml')
You may also specify the config directly via JSON/a dictionary with
substrate tapestry start -c "{ config here... }"
or
stack = Substrate('tool_name', config)
The options for the configuration file can be found here.
Each 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 and Braid.
For more information on configuring each tool, please refer to each tools documentation:
- NetCDF Slicer: coming soon
- OSPRay Studio
- Tapestry
- Braid
Development Environment
To setup the dev environment, please install Pipenv. Once installed, run the following commands to set up the development environment:
pipenv --python /path/to/your/python3.10
pipenv sync -d
pipenv shell
Uploading to PyPI
To upload to prepare a new release, run the following commands:
python -m build
python -m twine upload dist/*
1 maintainer
Release files for seelabutk-substrate 1.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| seelabutk-substrate-1.9.0.tar.gz | 61.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| seelabutk_substrate-1.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 131.9 kB
Release files / seelabutk-substrate-1.9.0.tar.gz
| Download URL | seelabutk-substrate-1.9.0.tar.gz |
|---|---|
| Size | 61.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2d852848c109840053e881139e178a1a879893d4554f704dd09b6ff25de1e76
|
|
BLAKE2b-256 checksum How to use checksums |
b81545e5599fcde097f8e444ea7c3e279566448773e4a63203322bbc942fcd5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
Release files / seelabutk_substrate-1.9.0-py3-none-any.whl
| Download URL | seelabutk_substrate-1.9.0-py3-none-any.whl |
|---|---|
| Size | 70.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4469c290a0814e48fa94c185386bd291a769be8480f0ba56e3971182ae12ece9
|
|
BLAKE2b-256 checksum How to use checksums |
462a11d7b8396bb36984c9db4ae9ffc6efb2fa3ff4c12c8a4464fedef6e1ad1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
