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
  • vci

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 VCI.

For more information on configuring each tool, please refer to each tools documentation:

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.9.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for evilkermit from gravatar.com evilkermit

Credits

Author: John Duggan

License

CC-BY-4.0

Requires

Python >=3.7

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seelabutk-substrate-1.1.0.tar.gz (61.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

seelabutk_substrate-1.1.0-py3-none-any.whl (69.8 kB view details)

Uploaded Python 3

File details

Details for the file seelabutk-substrate-1.1.0.tar.gz.

File metadata

  • Download URL: seelabutk-substrate-1.1.0.tar.gz
  • Upload date:
  • Size: 61.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for seelabutk-substrate-1.1.0.tar.gz
Algorithm Hash digest
SHA256 eccda8bfdc699402f809467a8dd3103397935606f10efebeb7f807f257cee9a4
MD5 fc9864085c2355c2e153221e3e36619c
BLAKE2b-256 5ab8de0519c51806c31a4dc3ea93e74df74e748f619956a46cecda70e0c42cca

See more details on using hashes here.

File details

Details for the file seelabutk_substrate-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for seelabutk_substrate-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 88dc14d39b77de94a5e4c25b902532aa69c8bcbe2973c8255989ae31d67ba9a8
MD5 e62fdf4544dacd24540a2f16b6fe2768
BLAKE2b-256 ab602cc33185865717577cdd0db4178afc510122b7834d7a5262752cefab4237

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page