People-Places-Solutions/floodmodeller-api

IEF Test simulation

Open

#256 opened on May 20, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (23 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

This is a request for an enhancement to the API capability. Using the command line options for running flood modeller models its possible to test the integrity of a model (by processing the data and running a small number of timesteps). It allows the user to check any required files are located as expected, without outputting any results or requiring a Flood Modeller (Standard or Professional edition) licence to do so. Running-1D-Simulations-in-test-mode it would be great if this functionality could be added to the FMAPI please

Contributor guide

Research direction
Examine the existing simulation execution flow in the floodmodeller api source code. Identify where simulation parameters are handled and how to integrate a 'test mode' flag that limits timesteps without output or license validation. Review the linked documentation for command line test implementation for guidance.
Tech stack
python
Domain
api
Issue type
Feature
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-2 days
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60