VOR Stream Features¶
VOR Stream is a system for creating and maintaining processes designed to solve financial risk problems. Key features of the system are:
- Batch-Stream oriented execution of a process - i.e., partial results available early - before the job finishes
- Parallel processing across threads, across machines, and across the workflow
- Each step (node) in the process is run independently and simultaneously of the other steps
- Each step can be written in a different language (Python, Golang, SAS, and SQL languages are currently supported)
- Documentation is autogenerated
Replay Feature¶
VOR Stream is playpen oriented. A node named bar
in a playpen called mine
is
different than a node named bar
in a playpen called mine2
. If you create a
new playpen and pull the source from a repository or copy directly from another
playpen, you need to register this playpen and its artifacts with the mid-tier.
Running, vor create queue
and
vor create process
actions without options registered these objects with the mid-tier. If any nodes
or processes are not needed for this new playpen, use the --delete
option to
remove those features before or after executing the replay.
Documentation¶
Queues, nodes, and processes automatically generate documentation when they are
created. Once the documentation is created for computational nodes, and
processes, the documentation is not updated if one of these objects is updated.
If you want the documentation to be updated, delete the specific document
located in <playpen-dir>/docs
directory and recreate the node or process.
Documentation is created in Markdown format that can be easily modified,
extended, and themed. Documentation is stored in the <playpen-dir>/src/docs
directory so it is under source control. The documentation is then converted to
static web pages to be referenced from the UI. The static web pages are
generated using MkDocs and is built when you execute
the vor create process
command.