floodmodeller-api 0.5.0.post1__py3-none-any.whl → 0.5.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. floodmodeller_api/__init__.py +11 -1
  2. floodmodeller_api/_base.py +55 -36
  3. floodmodeller_api/backup.py +15 -12
  4. floodmodeller_api/dat.py +191 -121
  5. floodmodeller_api/diff.py +4 -4
  6. floodmodeller_api/hydrology_plus/hydrology_plus_export.py +15 -14
  7. floodmodeller_api/ied.py +8 -10
  8. floodmodeller_api/ief.py +56 -42
  9. floodmodeller_api/ief_flags.py +1 -1
  10. floodmodeller_api/inp.py +7 -10
  11. floodmodeller_api/logs/lf.py +25 -26
  12. floodmodeller_api/logs/lf_helpers.py +20 -20
  13. floodmodeller_api/logs/lf_params.py +1 -5
  14. floodmodeller_api/mapping.py +11 -2
  15. floodmodeller_api/test/__init__.py +2 -2
  16. floodmodeller_api/test/conftest.py +2 -3
  17. floodmodeller_api/test/test_backup.py +2 -2
  18. floodmodeller_api/test/test_conveyance.py +13 -7
  19. floodmodeller_api/test/test_dat.py +168 -20
  20. floodmodeller_api/test/test_data/EX18_DAT_expected.json +164 -144
  21. floodmodeller_api/test/test_data/EX3_DAT_expected.json +6 -2
  22. floodmodeller_api/test/test_data/EX6_DAT_expected.json +12 -46
  23. floodmodeller_api/test/test_data/encoding_test_cp1252.dat +1081 -0
  24. floodmodeller_api/test/test_data/encoding_test_utf8.dat +1081 -0
  25. floodmodeller_api/test/test_data/integrated_bridge/AR_NoSP_NoBl_2O_NO_OneFRC.ied +33 -0
  26. floodmodeller_api/test/test_data/integrated_bridge/AR_vSP_25pc_1O.ied +32 -0
  27. floodmodeller_api/test/test_data/integrated_bridge/PL_vSP_25pc_1O.ied +34 -0
  28. floodmodeller_api/test/test_data/integrated_bridge/SBTwoFRCsStaggered.IED +32 -0
  29. floodmodeller_api/test/test_data/integrated_bridge/US_NoSP_NoBl_OR_RN.ied +28 -0
  30. floodmodeller_api/test/test_data/integrated_bridge/US_SP_NoBl_OR_frc_PT2-5_RN.ied +34 -0
  31. floodmodeller_api/test/test_data/integrated_bridge/US_fSP_NoBl_1O.ied +30 -0
  32. floodmodeller_api/test/test_data/integrated_bridge/US_nSP_NoBl_1O.ied +49 -0
  33. floodmodeller_api/test/test_data/integrated_bridge/US_vSP_NoBl_2O_Para.ied +35 -0
  34. floodmodeller_api/test/test_data/integrated_bridge.dat +40 -0
  35. floodmodeller_api/test/test_data/network.ied +2 -2
  36. floodmodeller_api/test/test_data/network_dat_expected.json +141 -243
  37. floodmodeller_api/test/test_data/network_ied_expected.json +2 -2
  38. floodmodeller_api/test/test_data/network_with_comments.ied +2 -2
  39. floodmodeller_api/test/test_data/structure_logs/EX17_expected.csv +4 -0
  40. floodmodeller_api/test/test_data/structure_logs/EX17_expected.json +69 -0
  41. floodmodeller_api/test/test_data/structure_logs/EX18_expected.csv +20 -0
  42. floodmodeller_api/test/test_data/structure_logs/EX18_expected.json +292 -0
  43. floodmodeller_api/test/test_data/structure_logs/EX6_expected.csv +4 -0
  44. floodmodeller_api/test/test_data/structure_logs/EX6_expected.json +35 -0
  45. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzn_flow.csv +182 -0
  46. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzn_fr.csv +182 -0
  47. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzn_mode.csv +182 -0
  48. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzn_stage.csv +182 -0
  49. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzn_state.csv +182 -0
  50. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzn_velocity.csv +182 -0
  51. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzx_left_fp_h.csv +182 -0
  52. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzx_left_fp_mode.csv +182 -0
  53. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzx_link_inflow.csv +182 -0
  54. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzx_max.csv +87 -0
  55. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzx_right_fp_h.csv +182 -0
  56. floodmodeller_api/test/test_data/tabular_csv_outputs/network_zzx_right_fp_mode.csv +182 -0
  57. floodmodeller_api/test/test_flowtimeprofile.py +2 -2
  58. floodmodeller_api/test/test_hydrology_plus_export.py +4 -2
  59. floodmodeller_api/test/test_ied.py +3 -3
  60. floodmodeller_api/test/test_ief.py +12 -4
  61. floodmodeller_api/test/test_inp.py +2 -2
  62. floodmodeller_api/test/test_integrated_bridge.py +159 -0
  63. floodmodeller_api/test/test_json.py +14 -13
  64. floodmodeller_api/test/test_logs_lf.py +50 -29
  65. floodmodeller_api/test/test_read_file.py +1 -0
  66. floodmodeller_api/test/test_river.py +12 -12
  67. floodmodeller_api/test/test_tool.py +8 -5
  68. floodmodeller_api/test/test_toolbox_structure_log.py +148 -158
  69. floodmodeller_api/test/test_xml2d.py +14 -16
  70. floodmodeller_api/test/test_zz.py +143 -0
  71. floodmodeller_api/to_from_json.py +9 -9
  72. floodmodeller_api/tool.py +15 -11
  73. floodmodeller_api/toolbox/example_tool.py +5 -1
  74. floodmodeller_api/toolbox/model_build/add_siltation_definition.py +13 -9
  75. floodmodeller_api/toolbox/model_build/structure_log/structure_log.py +500 -194
  76. floodmodeller_api/toolbox/model_build/structure_log_definition.py +5 -1
  77. floodmodeller_api/units/__init__.py +15 -0
  78. floodmodeller_api/units/_base.py +87 -20
  79. floodmodeller_api/units/_helpers.py +343 -0
  80. floodmodeller_api/units/boundaries.py +59 -71
  81. floodmodeller_api/units/comment.py +1 -1
  82. floodmodeller_api/units/conduits.py +57 -54
  83. floodmodeller_api/units/connectors.py +112 -0
  84. floodmodeller_api/units/controls.py +107 -0
  85. floodmodeller_api/units/conveyance.py +1 -1
  86. floodmodeller_api/units/iic.py +2 -9
  87. floodmodeller_api/units/losses.py +44 -45
  88. floodmodeller_api/units/sections.py +52 -51
  89. floodmodeller_api/units/structures.py +361 -531
  90. floodmodeller_api/units/units.py +27 -26
  91. floodmodeller_api/units/unsupported.py +5 -7
  92. floodmodeller_api/units/variables.py +2 -2
  93. floodmodeller_api/urban1d/_base.py +13 -17
  94. floodmodeller_api/urban1d/conduits.py +11 -21
  95. floodmodeller_api/urban1d/general_parameters.py +1 -1
  96. floodmodeller_api/urban1d/junctions.py +7 -11
  97. floodmodeller_api/urban1d/losses.py +13 -17
  98. floodmodeller_api/urban1d/outfalls.py +18 -22
  99. floodmodeller_api/urban1d/raingauges.py +5 -10
  100. floodmodeller_api/urban1d/subsections.py +5 -4
  101. floodmodeller_api/urban1d/xsections.py +14 -17
  102. floodmodeller_api/util.py +23 -6
  103. floodmodeller_api/validation/parameters.py +7 -3
  104. floodmodeller_api/validation/urban_parameters.py +1 -4
  105. floodmodeller_api/validation/validation.py +11 -5
  106. floodmodeller_api/version.py +1 -1
  107. floodmodeller_api/xml2d.py +27 -31
  108. floodmodeller_api/xml2d_template.py +1 -1
  109. floodmodeller_api/zz.py +539 -0
  110. {floodmodeller_api-0.5.0.post1.dist-info → floodmodeller_api-0.5.2.dist-info}/LICENSE.txt +1 -1
  111. {floodmodeller_api-0.5.0.post1.dist-info → floodmodeller_api-0.5.2.dist-info}/METADATA +30 -16
  112. {floodmodeller_api-0.5.0.post1.dist-info → floodmodeller_api-0.5.2.dist-info}/RECORD +116 -83
  113. {floodmodeller_api-0.5.0.post1.dist-info → floodmodeller_api-0.5.2.dist-info}/WHEEL +1 -1
  114. floodmodeller_api/test/test_zzn.py +0 -36
  115. floodmodeller_api/units/helpers.py +0 -123
  116. floodmodeller_api/zzn.py +0 -414
  117. /floodmodeller_api/test/test_data/{network_from_tabularCSV.csv → tabular_csv_outputs/network_zzn_max.csv} +0 -0
  118. {floodmodeller_api-0.5.0.post1.dist-info → floodmodeller_api-0.5.2.dist-info}/entry_points.txt +0 -0
  119. {floodmodeller_api-0.5.0.post1.dist-info → floodmodeller_api-0.5.2.dist-info}/top_level.txt +0 -0
floodmodeller_api/test/test_data/structure_logs/EX18_expected.json ADDED
@@ -0,0 +1,292 @@
1
+ {
2
+ "(C2,CONDUIT)": {
3
+ "name": "C2",
4
+ "type": "CONDUIT",
5
+ "subtype": "CIRCULAR",
6
+ "comment": "",
7
+ "conduit_data": {
8
+ "length": 100.0,
9
+ "inlet": 0.6,
10
+ "total_length": 500.0
11
+ },
12
+ "dimensions": {
13
+ "invert": 20.0,
14
+ "diameter": 1.0
15
+ },
16
+ "friction": {
17
+ "friction_eq": "MANNING",
18
+ "friction_set": [
19
+ 0.015,
20
+ 0.02
21
+ ],
22
+ "all_friction": [
23
+ 0.015,
24
+ 0.02
25
+ ]
26
+ }
27
+ },
28
+ "(C2_R1,REPLICATE)": {
29
+ "name": "C2_R1",
30
+ "type": "REPLICATE",
31
+ "subtype": null,
32
+ "comment": "",
33
+ "conduit_data": {
34
+ "length": 100.0
35
+ },
36
+ "dimensions": {
37
+ "bed_level_drop": 0.2,
38
+ "mimic": "C2m"
39
+ }
40
+ },
41
+ "(C2_R2,REPLICATE)": {
42
+ "name": "C2_R2",
43
+ "type": "REPLICATE",
44
+ "subtype": null,
45
+ "comment": "",
46
+ "conduit_data": {
47
+ "length": 100.0
48
+ },
49
+ "dimensions": {
50
+ "bed_level_drop": 0.2,
51
+ "mimic": "C2m"
52
+ }
53
+ },
54
+ "(C2_R3,REPLICATE)": {
55
+ "name": "C2_R3",
56
+ "type": "REPLICATE",
57
+ "subtype": null,
58
+ "comment": "",
59
+ "conduit_data": {
60
+ "length": 100.0
61
+ },
62
+ "dimensions": {
63
+ "bed_level_drop": 0.2,
64
+ "mimic": "C2m"
65
+ }
66
+ },
67
+ "(C2_R4,REPLICATE)": {
68
+ "name": "C2_R4",
69
+ "type": "REPLICATE",
70
+ "subtype": null,
71
+ "comment": "",
72
+ "conduit_data": {
73
+ "length": 100.0
74
+ },
75
+ "dimensions": {
76
+ "bed_level_drop": 0.2,
77
+ "mimic": "C2m"
78
+ }
79
+ },
80
+ "(C2m,CONDUIT)": {
81
+ "name": "C2m",
82
+ "type": "CONDUIT",
83
+ "subtype": "CIRCULAR",
84
+ "comment": "",
85
+ "conduit_data": {
86
+ "length": 0.0
87
+ },
88
+ "dimensions": {
89
+ "invert": 19.2,
90
+ "diameter": 1.0
91
+ },
92
+ "friction": {
93
+ "friction_eq": "MANNING",
94
+ "friction_set": [
95
+ 0.015,
96
+ 0.02
97
+ ],
98
+ "all_friction": [
99
+ 0.015,
100
+ 0.02
101
+ ]
102
+ }
103
+ },
104
+ "(C2md,CONDUIT)": {
105
+ "name": "C2md",
106
+ "type": "CONDUIT",
107
+ "subtype": "CIRCULAR",
108
+ "comment": "",
109
+ "conduit_data": {
110
+ "length": 100.0,
111
+ "total_length": 700.0
112
+ },
113
+ "dimensions": {
114
+ "invert": 19.2,
115
+ "diameter": 1.0
116
+ },
117
+ "friction": {
118
+ "friction_eq": "MANNING",
119
+ "friction_set": [
120
+ 0.015,
121
+ 0.02
122
+ ],
123
+ "all_friction": [
124
+ 0.015,
125
+ 0.02
126
+ ]
127
+ }
128
+ },
129
+ "(C2_R5,REPLICATE)": {
130
+ "name": "C2_R5",
131
+ "type": "REPLICATE",
132
+ "subtype": null,
133
+ "comment": "",
134
+ "conduit_data": {
135
+ "length": 100.0
136
+ },
137
+ "dimensions": {
138
+ "bed_level_drop": 0.2,
139
+ "mimic": "C2d"
140
+ }
141
+ },
142
+ "(C2_R6,REPLICATE)": {
143
+ "name": "C2_R6",
144
+ "type": "REPLICATE",
145
+ "subtype": null,
146
+ "comment": "",
147
+ "conduit_data": {
148
+ "length": 100.0
149
+ },
150
+ "dimensions": {
151
+ "bed_level_drop": 0.2,
152
+ "mimic": "C2d"
153
+ }
154
+ },
155
+ "(C2_R7,REPLICATE)": {
156
+ "name": "C2_R7",
157
+ "type": "REPLICATE",
158
+ "subtype": null,
159
+ "comment": "",
160
+ "conduit_data": {
161
+ "length": 100.0
162
+ },
163
+ "dimensions": {
164
+ "bed_level_drop": 0.2,
165
+ "mimic": "C2d"
166
+ }
167
+ },
168
+ "(C2_R8,REPLICATE)": {
169
+ "name": "C2_R8",
170
+ "type": "REPLICATE",
171
+ "subtype": null,
172
+ "comment": "",
173
+ "conduit_data": {
174
+ "length": 100.0
175
+ },
176
+ "dimensions": {
177
+ "bed_level_drop": 0.2,
178
+ "mimic": "C2d"
179
+ }
180
+ },
181
+ "(C2_R9,REPLICATE)": {
182
+ "name": "C2_R9",
183
+ "type": "REPLICATE",
184
+ "subtype": null,
185
+ "comment": "",
186
+ "conduit_data": {
187
+ "length": 100.0
188
+ },
189
+ "dimensions": {
190
+ "bed_level_drop": 0.2,
191
+ "mimic": "C2d"
192
+ }
193
+ },
194
+ "(C2_R10,REPLICATE)": {
195
+ "name": "C2_R10",
196
+ "type": "REPLICATE",
197
+ "subtype": null,
198
+ "comment": "",
199
+ "conduit_data": {
200
+ "length": 100.0
201
+ },
202
+ "dimensions": {
203
+ "bed_level_drop": 0.2,
204
+ "mimic": "C2d"
205
+ }
206
+ },
207
+ "(C2d,CONDUIT)": {
208
+ "name": "C2d",
209
+ "type": "CONDUIT",
210
+ "subtype": "CIRCULAR",
211
+ "comment": "",
212
+ "conduit_data": {
213
+ "length": 0.0
214
+ },
215
+ "dimensions": {
216
+ "invert": 18.0,
217
+ "diameter": 1.0
218
+ },
219
+ "friction": {
220
+ "friction_eq": "MANNING",
221
+ "friction_set": [
222
+ 0.015,
223
+ 0.02
224
+ ],
225
+ "all_friction": [
226
+ 0.015,
227
+ 0.02
228
+ ]
229
+ }
230
+ },
231
+ "(S0,WEIR)": {
232
+ "name": "S0",
233
+ "type": "WEIR",
234
+ "subtype": null,
235
+ "comment": "",
236
+ "dimensions": {
237
+ "weir_elevation": 21.0,
238
+ "weir_breadth": 1.5
239
+ }
240
+ },
241
+ "(C2d,WEIR)": {
242
+ "name": "C2d",
243
+ "type": "WEIR",
244
+ "subtype": null,
245
+ "comment": "",
246
+ "dimensions": {
247
+ "weir_elevation": 18.0,
248
+ "weir_breadth": 0.6
249
+ }
250
+ },
251
+ "(S4,WEIR)": {
252
+ "name": "S4",
253
+ "type": "WEIR",
254
+ "subtype": null,
255
+ "comment": "",
256
+ "dimensions": {
257
+ "weir_elevation": 17.9,
258
+ "weir_breadth": 2.0
259
+ }
260
+ },
261
+ "(S8,WEIR)": {
262
+ "name": "S8",
263
+ "type": "WEIR",
264
+ "subtype": null,
265
+ "comment": "",
266
+ "dimensions": {
267
+ "weir_elevation": 17.7,
268
+ "weir_breadth": 2.0
269
+ }
270
+ },
271
+ "(S3LS,SPILL)": {
272
+ "name": "S3LS",
273
+ "type": "SPILL",
274
+ "subtype": null,
275
+ "comment": "",
276
+ "dimensions": {
277
+ "invert": 20.0,
278
+ "width": 100.0,
279
+ "weir_coefficient": 1.7,
280
+ "section_data": {
281
+ "x": [
282
+ 0.0,
283
+ 100.0
284
+ ],
285
+ "y": [
286
+ 20.0,
287
+ 20.0
288
+ ]
289
+ }
290
+ }
291
+ }
292
+ }
floodmodeller_api/test/test_data/structure_logs/EX6_expected.csv ADDED
@@ -0,0 +1,4 @@
1
+ Unit Name,Unit Type,Unit Subtype,Comment,Friction,Dimensions (m),Weir Coefficient,Culvert Inlet/Outlet Loss
2
+ P0000a,SLUICE,VERTICAL,,,Crest Elevation: 73.20 x w: 20.00 x l: 1.00,,
3
+ P11951U,SLUICE,VERTICAL,,,Crest Elevation: 73.00 x w: 3.36 x l: 1.00,,
4
+ P44865U,SLUICE,VERTICAL,,,Crest Elevation: 70.81 x w: 3.36 x l: 3.00,,
floodmodeller_api/test/test_data/structure_logs/EX6_expected.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "(P0000a,SLUICE)": {
3
+ "name": "P0000a",
4
+ "type": "SLUICE",
5
+ "subtype": "VERTICAL",
6
+ "comment": "",
7
+ "dimensions": {
8
+ "weir_length": 1.0,
9
+ "crest_elevation": 73.2,
10
+ "weir_breadth": 20.0
11
+ }
12
+ },
13
+ "(P11951U,SLUICE)": {
14
+ "name": "P11951U",
15
+ "type": "SLUICE",
16
+ "subtype": "VERTICAL",
17
+ "comment": "",
18
+ "dimensions": {
19
+ "weir_length": 1.0,
20
+ "crest_elevation": 73.0,
21
+ "weir_breadth": 3.36
22
+ }
23
+ },
24
+ "(P44865U,SLUICE)": {
25
+ "name": "P44865U",
26
+ "type": "SLUICE",
27
+ "subtype": "VERTICAL",
28
+ "comment": "",
29
+ "dimensions": {
30
+ "weir_length": 3.0,
31
+ "crest_elevation": 70.81,
32
+ "weir_breadth": 3.36
33
+ }
34
+ }
35
+ }