imperialqore/line-grspn-rest repository overview

⁠line-grspn-rest (Docker image)

REST packaging of GreatSPN, the GRaphical Editor and Analyzer for Timed and Stochastic Petri Nets, for use as an external solver of the LINE solver⁠.

All credit for GreatSPN belongs to its authors. This image contributes no method, no algorithm and no result: it only runs the upstream binaries as subprocesses and returns their parsed output as JSON. Upstream project: http://www.di.unito.it/~greatspn/⁠ and https://github.com/greatspn/SOURCES⁠.

⁠Usage

⁠REST server (default)

docker run -d -p 8080:8080 imperialqore/line-grspn-rest
curl -s http://127.0.0.1:8080/api/v1/health

Interactive API documentation is served at /docs and /redoc.

⁠Command line

Any argument other than serve is executed directly, so the image is a strict superset of a plain CLI container:

docker run --rm -v "$PWD:/data" -w /data imperialqore/line-grspn-rest \
    /usr/local/GreatSPN/bin/DSPN-Tool -load mymodel -trg -s

Every route runs DSPN-Tool, GSPNRG or GSPNSIM. The revision that was built is recorded in /usr/local/GreatSPN/VERSION and served as the version field of every response.

⁠API

Base path /api/v1. GET /health, /ready, /info and /citation, plus the solve routes; see /docs on a running container for the full schema.

⁠Reproducibility

The build is self-contained: it starts from fedora:34 and compiles GreatSPN and its dependencies (Meddly, SPOT, OGDF, lp_solve) from source. Every external input is pinned, because the upstream recipe clones each dependency at HEAD and therefore produced a different image every day:

The three commits are the ones the retired imperialqore/greatspn image was built from, recovered from that image's own builder layer, so the pins reproduce it rather than freeze an arbitrary point.

⁠Credits

This image only packages GreatSPN. GreatSPN is not developed here, and no part of the analysis it performs is the work of this packaging. Publications reporting results obtained through this service must cite the references below, and must not cite this image or the packaging repository.

GreatSPN, the GRaphical Editor and Analyzer for Timed and Stochastic Petri Nets, is developed by Elvio Gilberto Amparore, Gianfranco Balbo, Marco Beccuti, Susanna Donatelli and Giuliana Franceschinis, at Universita di Torino (the source-code owner per the upstream README) and Universita del Piemonte Orientale (Franceschinis). Source: https://github.com/greatspn/SOURCES⁠. GreatSPN is licensed under GPL-2.0.

Reference to cite:

Additional references, when these components are used. Neither is reachable through this service, since every route runs DSPN-Tool, GSPNRG or GSPNSIM and neither component is present in the base image. They are recorded here, and served under the same heading by GET /api/v1/citation, for anyone who reaches them another way.

When the RGMEDD decision-diagram model checker is used, cite in addition:

When starMC is used, cite in addition:

Upstream project: http://www.di.unito.it/~greatspn/⁠, https://github.com/greatspn/SOURCES⁠

Packaged for: https://line-solver.sourceforge.net/⁠