coinstac-simulator

coinstac-simulator

COINSTAC simulator for computation runs. Documentation.

Installation

Ensure you have Node.js installed. Then, the following command from a shell:

npm install --global coinstac-simulator

Use

coinstac-simulator contains a command line interface and a Node.js API. The simulator is designed to be run in your root computation directory, but can be run by specifying exact paths to necessary files.

CLI

coinstac-simulator has no required flags, but will assume ./compspec.json, ./test/inputspec.json, and ./test/ for computation directory use eg: input|output. The later directories will be created automatically if they do not exist. File outputs are saved to ./test/[local#|remote]/output/simulatorRun, consecutive runs will overwrite data. If you do not have an input spec for you run, a prompt will ask you for inputs based on the current compspec and give you the option to persist that input spec.

An example computation specification, compspec.json, can be found here and here for decentralized computations.

For an in depth overview on how to create computations a guide can be found here

Run coinstac-simulator --help for more information on how to use the CLI.

Profiling

coinstac-simulator can output further profile timing information that may be useful to see performance bottlenecks in your computation. To access this information run simulator with the following envar exported export DEBUG=pipeline:profile* && coinstac-simulator --loglevel info

License

MIT. See LICENSE for details.