Added Soft Abort

[wk9874]

New Connector Feature - Soft Abort

Connector(s) Edited

Generic, MOOSE, FDS

Description of Feature

Use the new 'abort_callback' functionality of v1.1 Python API to perform a soft abort of run when an abort is triggered by the server. This means that instead of the whole script being exited, the simulation is stopped gracefully (including using a .stop file for FDS), and then the simvue run is allowed to complete by running post_simulation(). This means that unlike before, results are uploaded from partial / aborted runs, and if using a for loop to perform multiple simulations using multiple calls to .launch() the abort will not prevent this.

Also adds upload of all MOOSE output files to server, not just Exodus.

Adds unit tests for this functionality for MOOSE, FDS, OpenFOAM

Testing Performed

• Tested Software Version(s): MOOSE commit 87de105995, FDS v6.9.1
• Tested Operating System(s): Ubuntu 22.04
• Tested Python Version(s): Python 3.10
• Tested Simvue Python API Version(s): v1.1.0

Documentation

• Link to Documentation PR: N/A - no changes required

Links to Issues

Closes #20 Closes #22

Checklist

• [x] Code corresponds to the guidelines set out in the Contributing.md document
• [x] Any new Python package requirements have been added as an Extra to the pyproject.toml
• [x] Unit tests have been added which check all functionality of the new feature, using Mock functions to replicate the simulation software
• [x] All unit tests run and pass locally
• [ ] Integration tests have been updated to use the new feature and are passing in the CI
• [x] Code passes all pre-commit hooks
• [ ] The Integrations and Examples pages of the documentation have been updated to include information about your new feature (if applicable)
• [ ] Example scripts have been updated to include your new feature

Comments

No need to update documentation No integration tests implemented yet One unit test failing locally, known issue #21