API framework for iSolve

[esraneufeld]

User Story:

sim4life:web currently runs iSolve in a subprocess and the task manager can display logs and progress info. This should be replaced by leveraging the osparc API to take advantage of scheduling those jobs. In a first step, the following features are required:

• Stream logs to the frontend
• Stream progress to the frontend
• Potentially users will reconnect to the scheduler, so logs/progress need to be re-flushed (Not possible with ARES now)
• Do we use tokens for this? Where do we store them (we dont want users to add them all the time). This will require platform wide user/service/version storage facilities (could be re-used for sim4life application preferencens.

Second step will include:

• In addition to logs/progress, convergence and sensor information in form of 2d-plots can be collected from iSolve. We should handle that as well.

Notes:

• If implemented properly in simphony, this will work automatically with the Desktop Application as well.
• See here for a prototype implementation for integration into sim4life

Sundae

Preview Give feedback

1. Submit jobs from the web version
2. Submit jobs from the desktop version

[pcrespov]

Update on sprint Croissant

osparc API allows to setup and run jobs with solvers published in osparc (e.g. isolve, opencor, ...).

Planned

• New API entrypoints should
  • get logs files
  • run jobs in a specify cluster
  • stream or tail logs while running a job
  • stream other info (e.g. progress, convergent ... ) from solver while running a job
• Generate client SDKs for this API: python and probably also start with C++
  • update reference documentation online
  • update basic tutorial

Done

• can download logs files when a job completes
  • ♻️ Is621/api server (preparation) osparc-simcore#3072
  • Is621/director2 adds routes to access logfile osparc-simcore#3067
  • ✨ Is621/api server exposes GET /solvers/*/releases/*/jobs/*/outputs/logfile (⚠️ devops) osparc-simcore#3051
• Extended basic tutorial with this new feature. SEE Tutorial.md

Ongoing

• v0.5.0 (beta): adds get_job_output_logfile and updates doc osparc-simcore-clients#27 : Demo logfile and release new client version+doc

Open

• specify cluster in run options
• logs stream or list (tail, etc)
• progress stream

[pcrespov]

Update on sprint Diolkos

No significant progress on this issue during this sprint

[sanderegg]

Notes:

• status on integration in Sim4Life desktop unclear

[sanderegg]

Main framework to submit jobs was completed with 7Peaks milestone .
Subsequent improvements/bugfixes will get their own issues.