scripts.render.run Namespace Reference

Classes
class	ViewerHandler

Functions
def	start_registry (client)
def	build (client, docker_img)
def	push (client, docker_img)
def	create_viewer_watchdog (client, ipc_dir, local_project_root)
def	run_ui (client, docker_img)
def	setup_local_gpu ()
def	main (argv)

Variables
	dir_scripts = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
	dir_root = os.path.dirname(dir_scripts)
	FLAGS = flags.FLAGS
	container_name = None
	autoreset

Function Documentation

build()

def scripts.render.run.build	(		client,
			docker_img
	)

Builds the Docker image.

Args:
    client (DockerClient): Docker client configured to the host environment.
    docker_img (str): Name of the Docker image.

Raises:
    Exception: If Docker encounters an issue during the build.

create_viewer_watchdog()

def scripts.render.run.create_viewer_watchdog	(		client,
			ipc_dir,
			local_project_root
	)

Sets up the Watchdog to monitor the files used to remotely call the viewers.

Args:
    client (DockerClient): Docker client configured to the host environment.
    ipc_dir (str): Directory where the files used to signal to the Watchdog reside.
    local_project_root (str): Path of the project on the host.

main()

def scripts.render.run.main

(

argv

)

Builds the Docker container corresponding to the project and starts the UI.
Upon exiting the UI, the script will terminate. Similarly, exiting the script
will terminate the UI.

Args:
    argv (list[str]): List of arguments (used interally by abseil).

push()

def scripts.render.run.push	(		client,
			docker_img
	)

Pushes the Docker image to the local registry.

Args:
    client (DockerClient): Docker client configured to the host environment.
    docker_img (str): Name of the Docker image.

Raises:
    Exception: If Docker encounters an issue during the push.

run_ui()

def scripts.render.run.run_ui	(		client,
			docker_img
	)

Starts the UI.

Args:
    client (DockerClient): Docker client configured to the host environment.
    docker_img (str): Name of the Docker image.

setup_local_gpu()

def scripts.render.run.setup_local_gpu

(

)

start_registry()

def scripts.render.run.start_registry

(

client

)

Starts a local Docker registry. If a registry already exists, nothing happens.

Args:
    client (DockerClient): Docker client configured to the host environment.

Variable Documentation

autoreset

scripts.render.run.autoreset

container_name

scripts.render.run.container_name = None

dir_root

scripts.render.run.dir_root = os.path.dirname(dir_scripts)

dir_scripts

scripts.render.run.dir_scripts = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

FLAGS

scripts.render.run.FLAGS = flags.FLAGS