package
0.0.0-20241027081200-36e249c46552
Repository: https://github.com/umbralcalc/stochadex.git
Documentation: pkg.go.dev

# Functions

ArgParse builds the configs parsed as args to the stochadex binary and also retrieves other args.
LoadApiRunConfigFromYaml creates a new ApiRunConfig from a provided yaml path.
LoadApiRunConfigStringsFromYaml creates a new ApiRunConfigStrings from a provided yaml path.
LoadSocketConfigFromYaml creates a new SocketConfig from a provided yaml path.
Run the the main run routine for the API.
RunWithParsedArgs takes in the outputs from ArgParse and runs the stochadex with these configurations.
StepAndServeWebsocket runs a simulation while serving a websocket with the simulator.WebsocketOutputFunction.
WriteMainProgram writes string representations of various types of data to a template /tmp/*main.go file ready for runtime execution in this *main.go.

# Variables

ApiCodeTemplate is a string representing the template for the API run code.

# Structs

ApiRunConfig is the yaml-loadable config which specifies the loadable config data within the generated code for an API run.
ApiRunConfigStrings is the yaml-loadable config which specifies the templating inputs for an API run.
EmbeddedRunConfig is the yaml-loadable config which consists of all the necessary config data for an embedded simulation run.
EmbeddedRunConfigStrings is the yaml-loadable config which consists of all the necessary templating inputs for an embedded simulation run.
ParsedArgs contains the information that needs to pass from the CLI to the runner in order to run the API.
PartitionConfigStrings holds the string Iteration implementations and the potential to define extra packages and variables in configuration.
RunConfig is the yaml-loadable config which consists of all the necessary config data for a simulation run.
RunConfigStrings is the yaml-loadable config which consists of all the necessary templating inputs for a simulation run.
SocketConfig is a yaml-loadable config for the real-time websocket connection to the simulation.