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:

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.2.tar.gz (60.4 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.2-py3-none-any.whl (67.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: seelabutk-substrate-1.1.2.tar.gz
  • Upload date:
  • Size: 60.4 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.2.tar.gz
Algorithm Hash digest
SHA256 a9cae8afe7e931b84cd336bb34fbfdc7944650ecd45ec7f504cef8b97638c18f
MD5 5fcb30a07ee7a70a869c1be66bc14ad3
BLAKE2b-256 3116df30eb91cdda69511cce9a34d40616d462a7ffa39ccba3fd26d6be67071e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for seelabutk_substrate-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fc18c1113c04ba5523f327e35c23832ba67822b79c90a0076d2e4560f4859060
MD5 6cce84d702bca2987004f478c607483a
BLAKE2b-256 0e5a240f357cb6cbda970092c8dd433da0f4988f2ca1488a80bd562babb83646

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 Sentry Error logging StatusPage Status page