entelechy runGenerated

Generated from the source

Data comes from entelechy help run --json.

Brief

Evaluate a scene once, or keep running it as its files change.

Synopsis

run <scene.esn>

Description

Evaluate a scene at time zero; write its picture to –out and each –save, in the format each file’s extension names, and nothing else. With –watch, keep running, at the seconds since it started, and republish Kernels as their files change; a rejected change keeps the running version. –window is the window a scene sized by window() would fill, in pixels, with its scale factor. –memory says how many mebibytes of Fields the Host may hold at once (2048 by default); a scene of millions of triangles wants more, and run, render, replay, serve, graph, trace and bench all take it. –work says how many million loop iterations one run of a Kernel may take, all its elements together (4000 by default), and the same commands take it. –profile prints how long each executed node took; it waits for the device after each one, so a GPU’s numbers are the work, not the submission, and the frame is slower than it would be. What measuring a node costs before it does anything is taken off every line; a node runs alone under a profile, so the lines add up to more than a frame, and the sum says by how much. It also lists each Kernel’s preparing: its compiling and its building on the device. –allow file.write=<dir> lets the scene’s outputs written to a file land in that directory and under it, once an evaluation that changed them commits; nothing is written without it. –allow file.delete=<dir> lets an output to files remove and rename files there. –allow file.read=<dir> lets a served scene’s inputs read files there: under serve, where an agent composes the scene, a scene reads only beside its documents without it. render, serve and the Player take all three. –allow clipboard.read and –allow clipboard.write let the Player’s scene read and write the system’s clipboard; elsewhere a scene’s clipboard is the session’s own, which a replay’s clipboard "text" fills, and needs neither. –grant field.read,field.write,… names the capabilities a Kernel may be given, and no others (every one without it): a Kernel that requires another is refused when it is prepared, and what ran before goes on running. render, serve, bench and the Player take it too.

Flags

flag	Value	Repeats	Description
--save	<node.port>=<file.field|.png|.ppm|.pgm|.wav|.mid|.csv|.json>	yes	Writes a node’s output to a file, in the format its extension names.
--out	<file.png|.ppm|.field>	no	Writes the scene’s picture to a file.
--watch	``	no	Keeps running and republishes Kernels as their files change.
--window	<w>x<h>[@<scale>]	no	The window a scene sized by window() fills, in pixels, with its scale factor.
--profile	``	no	Prints how long each executed node took.
--library	<dir|file>	no	Kernels the scene uses beside its own.
--input	<name>=<path>	yes	Reads the scene’s input from the path given, a file or a directory as the input reads; an external the scene leaves to its caller bound to a picture file.
--output	<name>=<path>	yes	Writes the scene’s output to the path given, a file or a directory as the output writes.
--param	<name>=<literal>	yes	Sets a graph parameter.
--backend	cpu|gpu|jit	no	The backend the scene runs on.
--no-fusion	``	no	Runs pointwise producers apart from their consumers.
--allow	file.read|file.write|file.delete=<dir>|clipboard.read|clipboard.write	yes	Lets the scene read files from, write its outputs into, or remove and rename files in, a directory; or read and write the system’s clipboard.
--grant	<capability,...>	no	The only capabilities a Kernel may be given.
--memory	<MB>	no	Mebibytes of Fields the Host may hold at once (2048 by default).
--work	<M>	no	Million loop iterations one run of a Kernel may take (4000 by default).
--small	<operations>	no	Operations a run may take, by its elements and its Kernel’s typical work, and go to the processor rather than the device (400000 by default; 0 keeps every run on the device).