glotaran / pyglotaran-examples

This repository hold examples showcasing the use of the pyglotaran package
MIT License
5 stars 7 forks source link

Run examples by a CLI #13

Closed s-weigand closed 3 years ago

s-weigand commented 3 years ago

To make running all examples (e.g. for a stability check of the pyglotaran API) as easy as possible it is nice to run them via a CLI. Also, making them run headless (no plots popping up and taking focus all the time) is a nice to have feature.

The CLI can be run by:

python scripts/run_examples.py [--headless] <example_name>

To run all examples use:

python scripts/run_examples.py [--headless] run-all

When run in headless mode, all plots will be saved in a single pdf per test in the folder plot_results.

In addition to the CLI this PR adds a composite action which can be used as integration tests pyglotaran and maybe pyglotaran-extras.

As an internal test it also adds a workflow to test against pyglotaran which by default runs against main (see this run with my branches, since this PR isn't merged the files it uses don't exists as of yet).

lgtm-com[bot] commented 3 years ago

This pull request introduces 1 alert when merging e7703a82fdc934626930ce300faccf9aacd8034f into 62d33f8ae3d763b270d8a38b623d019196e614ea - view on LGTM.com

new alerts: