People-Places-Solutions/floodmodeller-api

IEF.simulate() needs some reconsideration/reworking

Open

#250 opened on May 5, 2026

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (23 forks)auto 404
bughelp wanted

Repository metrics

Stars
 (42 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, once the simulation process has finished the code will attempt to read the .exy to evaluate the state of the run. However, this seems to return a FileNotFoundError when I tested it, as the code could not find the .exy

For the use case that I was using this for, I only wanted python to perform the run, regardless of outcome, and then continue.

I think it's worth 'reinforcing' the code here so it's less likey to fail around not finding the .exy, this might have to be investigated; and possibly to be discussed something like this: on_completion: None | Callable = _summarise_exy as an argument. Note that IEF.simulate() doesn't seem to return anything at the moment anyways (given method="WAIT"); and/or just returning the exit code of the process itself (?)

Contributor guide

Research direction
Investigate why the .exy file is not found after simulation. Check the working directory, file naming conventions, and the timing of file creation. Consider adding an optional `on completion` parameter or returning the exit code to handle failures gracefully.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75