People-Places-Solutions/floodmodeller-api

Add option to enable or disable FAST in `XML2D`

Open

#156 opened on Jan 8, 2025

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

The XML2D.simulate method currently defaults to using the FAST engine if all domains use the FAST scheme, without giving users explicit control. This limits flexibility when users want to override the default behaviour. We should add in the option to choose whether or not to use FAST.

Contributor guide

Research direction
Examine the XML2D.simulate method and its current FAST engine usage. Add an optional parameter to enable or disable FAST, defaulting to the current behavior.
Tech stack
python
Domain
backendapi
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonFamiliarity with Flood Modeller API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70