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.1.tar.gz (61.3 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.1-py3-none-any.whl (69.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: seelabutk-substrate-1.1.1.tar.gz
  • Upload date:
  • Size: 61.3 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.1.tar.gz
Algorithm Hash digest
SHA256 20eb9fbcc47c6523689f66ee39979510b1b41508d4c1067bb1a2b0c52575c243
MD5 29a022ef2507c72a51494678c9374bc4
BLAKE2b-256 3c7670a3262fee9c29bc2687587a778b24efab8e3f2d62ad8676dafb4c877504

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for seelabutk_substrate-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 87508ea4ca9f197679f34ebed180553597f778a9eefcc2123b65d857bad2ba43
MD5 fc7ef7797f3c430bb3ae3583f882dad2
BLAKE2b-256 d846da2ea27534b5fc8299a6d11f7c65e573b559b7d31bd918b5029e58aaba55

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