Skip to content

Commit 929442a

Browse files
authored
draft test plan, add todo comment to converter (#190)
summarize testing discussion yesterday, and leave a TODO comment
1 parent 0f26945 commit 929442a

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/dev/test.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# FloPy 4 testing plan
2+
3+
## Phase 1: MVP testing
4+
5+
Reproduce the FloPy3 quickstart.
6+
7+
Hand-write a small number of programmatically defined models, patterned after simple FloPy3 and MF6 test cases. Support only limited simulations at first (e.g. just GWF), until code generation is implemented.
8+
9+
Set up CI test harness to compare results of simulations written by FloPy3 and the product. Reuse patterns in MF6 tests: comparisons and/or snapshots. Catalog and resolve differences in simulation output as they are discovered. Begin with the set of [MODFLOW 6 test models](https://github.com/MODFLOW-ORG/modflow6-testmodels) since the input files are readily available.
10+
11+
Alpha testers provide feedback.
12+
13+
## Phase 2: MMP testing
14+
15+
Adapt FloPy3 Python tests and MF6 examples to the product. Exhaustively characterize differences (API and behavior) between FloPy3 and the product, including cosmetic differences in input files written by the two systems.
16+
17+
Beta testers provide feedback.

flopy4/mf6/converter.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,9 @@ def dict_to_array(value, self_, field) -> NDArray:
259259
"""
260260
Convert a sparse dictionary representation of an array to a
261261
dense numpy array or a sparse COO array.
262+
263+
TODO: generalize this not only to dictionaries but to any
264+
form that can be converted to an array (e.g. nested list)
262265
"""
263266

264267
if not isinstance(value, dict):

0 commit comments

Comments
 (0)