Commands¶
ligo-scald provides a command line interface for various tasks:
scald serve: serving data and dynamic html pages
scald deploy: deploys a web application on the LDG
scald mock: starts up a mock database that generates data based on HTTP requests
scald report: generates offline html reports
scald serve¶
This command allow access to a dynamic dashboard and serves data from a variety of data backends. It does this by running a web server that responds to HTTP queries.
It is required to provide a configuration file that defines the data products that
can be queried, as well as the plots that get shown on the dashboard. This can be done
by providing a configuration file by -c /path/to/config.yml or by setting
SCALDRC_PATH to point towards the configuration.
scald deploy¶
This command sets everything needed to deploy scald serve on the LDG, or any place
where running a local web server is not appropriate. This leverages the public_html/cgi-bin
folder that is used to run CGI applications by the LDG’s web server.
scald mock¶
This command starts up a mock database that is used for testing purposes and to run a local dashboard based on randomly generated data. Specifically, this mocks a subset of a InfluxDB database, and so instantiating an influx Consumer and making queries will return back data in the same way as a production database.
scald report¶
This command generate offline-style HTML reports given a configuration file. This is an alternative to the programmatic report interface, and can be used for prototyping quick changes to a auto-generated report configuration file.