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 -c /path/to/substrate.config.yaml
or
stack = Substrate('tool_name', path='path/to/substrate.config.yaml')
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file seelabutk-substrate-1.4.2.tar.gz.
File metadata
- Download URL: seelabutk-substrate-1.4.2.tar.gz
- Upload date:
- Size: 60.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98a74dc2087dce28ce3e864a4b49c22879c9ac9a6f2aa31d0dd30f495c898b40
|
|
| MD5 |
3f213b4af19c8e2584b7a5a7ee97554e
|
|
| BLAKE2b-256 |
198a10a2f7c459474b448c2e7a6c6edf9d179c26c4070bbba4fdee906f9c024e
|
File details
Details for the file seelabutk_substrate-1.4.2-py3-none-any.whl.
File metadata
- Download URL: seelabutk_substrate-1.4.2-py3-none-any.whl
- Upload date:
- Size: 67.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
04150e6e506da5a2ab9c3356371ba8fa7d654f9c7e9d4350f6743adac3833507
|
|
| MD5 |
703ee353a7b9bba503c84ed9ff68d24b
|
|
| BLAKE2b-256 |
f925346679aa89b13b214232562f43bc5ed2f69e4b430c7b13f2a89e825d6856
|
