floodmodeller-api 0.5.2.post1__py3-none-any.whl → 0.5.3.post1__py3-none-any.whl

floodmodeller_api/xml2d.py

@@ -442,7 +442,7 @@ class XML2D(FMFile):
         # Update XML dict and tree
         self._read()
 
-    def save(self, filepath: str | Path | None):
+    def save(self, filepath: str | Path) -> None:
         """Saves the XML to the given location, if pointing to an existing file it will be overwritten.
         Once saved, the XML() class will continue working from the saved location, therefore any further calls to XML.update() will
         update in the latest saved location rather than the original source XML used to construct the class

{floodmodeller_api-0.5.2.post1.dist-info → floodmodeller_api-0.5.3.post1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: floodmodeller_api
-Version: 0.5.2.post1
+Version: 0.5.3.post1
 Summary: Extends the functionality of Flood Modeller to python users
 Author: Jacobs
 Author-email: joe.pierce@jacobs.com
@@ -24,6 +24,7 @@ Dynamic: author-email
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-dist
 Dynamic: summary
@@ -60,7 +61,8 @@ You can install the floodmodeller_api package from PyPI with the following comma
 pip install floodmodeller-api
 ```
 
-Python 3.10 or greater is required.
+Flood Modeller API is regularly tested for all versions of python 3.10 onwards. Although it may work for older versions of python, we recommend using at least v3.10 and ideally the latest 
+stable release.
 
 Once you have installed floodmodeller_api to your python environment, you can import the package with:
 

{floodmodeller_api-0.5.2.post1.dist-info → floodmodeller_api-0.5.3.post1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 floodmodeller_api/__init__.py,sha256=gPtU8nKJL-XHb19XuMryUpwlYNA3dlHlxl8xy69KPQA,400
-floodmodeller_api/_base.py,sha256=nr4MdHlxkoELCMvUHW0UnFdz-CHBy8_pz8L6zLZv27M,7761
+floodmodeller_api/_base.py,sha256=XY5bxyGzppQnY1SSL9qqBK0wCmvC9t3lQnj-jfnRLBU,7971
 floodmodeller_api/backup.py,sha256=Pdqq3VF-aiEuLOGFyoEINLc_vauhUeaNedJTa1cWDLI,11139
-floodmodeller_api/dat.py,sha256=tXv8AuH_ANtX7m4Xp46rqiPmLmihA92MrvK9QCgkBPI,40049
+floodmodeller_api/dat.py,sha256=S5bH9vxR-yINMpNeLuH1iUe3s_vKfq69TToID13PWRw,40061
 floodmodeller_api/diff.py,sha256=y7W5l-03iYdm-YPcwrbHZMdlXFhBe0JEl-WahWL_pi8,5208
-floodmodeller_api/ied.py,sha256=jl63fk1SlxMnrCjY4__rzP-W0HkL7HnjWYTeJR-Vy5E,12316
-floodmodeller_api/ief.py,sha256=6I2DJp4V2k7myNi7ot7iAwPrQns1iVc82huWFiqWg4Q,31039
+floodmodeller_api/ied.py,sha256=q8FWV2cQso7Tt9m73XGnK_5ZHTfQGW_LLtxwsY2sTus,12313
+floodmodeller_api/ief.py,sha256=u_VYIGkBQwHY7nSXVhT0G6-UkWmlpPLzkzodi9OPrIg,31891
 floodmodeller_api/ief_flags.py,sha256=WFP-mcIFIAf5DRpHH3BuP-zuzoIpm5wGxltTsXm0Wd8,11351
 floodmodeller_api/inp.py,sha256=o8hh7SmzTfuWWQVYTywIVWtPBCv-VCmrRzjGwwkFPUE,11012
-floodmodeller_api/mapping.py,sha256=hnj2a8lANznFc3QosGTtyHEpxVIKdE621_Ev3trb6J8,3717
+floodmodeller_api/mapping.py,sha256=eHbGYd7lFptmRvPYi4PxkvbD72w953RUb6KXKeiHTwg,3798
 floodmodeller_api/to_from_json.py,sha256=qyRKRe4mpdNBo6XgXVrP9dI3oqYY8Px5YcGm690F-jg,7427
 floodmodeller_api/tool.py,sha256=Lpx4LiF_OhCqt8KiXNtOrYx1K0tSwxig2ZJcGU3gbM4,11330
 floodmodeller_api/util.py,sha256=16oY6ia5SJjyjKYIoxa8jMw_sZ828y73NWbpe31ig-w,4590
-floodmodeller_api/version.py,sha256=jHthESksSvFIiblL_-OedpOncolw4EZ3jjkbbqg0oKA,28
-floodmodeller_api/xml2d.py,sha256=L99d147ySVIp8i1Ksp3ekyLDJ55MJ__dP32KXaVcR5o,25697
+floodmodeller_api/version.py,sha256=vAhdketIKWmjUuWZ8PfKJlRx4zq5ctgCLf0t58Wuui0,28
+floodmodeller_api/xml2d.py,sha256=MvH0oftUAdQRrsvxifXQOFwk0eB3sQOUX3qwU-58W6s,25698
 floodmodeller_api/xml2d_template.py,sha256=lu0tM7-YysYniqAw331bhvulH0Ha5xKsgtIo9KTnyNw,1806
 floodmodeller_api/xsd_backup.xml,sha256=hRZYhpNcucT7TgFPhuINMAEJOkds-lg6n7RH3b2jeq4,28430
 floodmodeller_api/zz.py,sha256=N9KHVPKyveDKG8jxrjuR0abHKbJhrTiKuNZ1kMD4zzs,20739
@@ -29,26 +29,29 @@ floodmodeller_api/libs/libsvml.so,sha256=tWR5ky0SlmJgWS8IGpRhtsD29pO-AU91hyUg866
 floodmodeller_api/libs/libzzn_read.so,sha256=hXX6heYoSDrn-2HmBQW8XNhO2wegq_Nrn_EjHjaN154,38696
 floodmodeller_api/libs/zzn_read.dll,sha256=XWNCUM7bm1exlOYfJd3tx7x6o-hy0x7hOEI34zT9R5E,84992
 floodmodeller_api/logs/__init__.py,sha256=nKqaEXuZ7ejfxlxb1-eINb-YiHon4eJjwiz_76aF4wQ,73
-floodmodeller_api/logs/lf.py,sha256=2LyQSY2jsF2XQ5j10fg2do0ZM5Eaz1dHGU7aiQvfD7E,12457
-floodmodeller_api/logs/lf_helpers.py,sha256=MkzxGivlnggCzbBFJ3se2zPxzX-zaAl6909QMML_AXY,10319
-floodmodeller_api/logs/lf_params.py,sha256=xsS4CciLc7wExsx8fyLE5Cd-0z0h6wx5lncix3CpWSE,18771
+floodmodeller_api/logs/lf.py,sha256=JQIzslhsF5RL8gliQ_KDFU3PscJg3aDOwzfcdkQbJKM,12641
+floodmodeller_api/logs/lf_helpers.py,sha256=Kh2Mkxcblvf_ra9cl1o42j3dD_xxNMjuyJ1h798eSkc,10394
+floodmodeller_api/logs/lf_params.py,sha256=JJxGB2xvNOS2TNikjLSchGXmVdSzXzpmjBmiywLWyTg,19919
 floodmodeller_api/test/__init__.py,sha256=H_reXbKdnzqlFWBdfJIPsgtRIXY7BxM1_p4oOvMhv88,91
 floodmodeller_api/test/conftest.py,sha256=_qZ3fepZ6TM-IbieVDIzHt5R8u-BybUbhGAZgdFKdzA,301
 floodmodeller_api/test/test_backup.py,sha256=_hGjDladK-EXa9uqzMlW7pJMvCldxiYdJn7dtqVQJq4,4221
 floodmodeller_api/test/test_conveyance.py,sha256=Urw85ev6aDMfKKwL4qG0pKSutnlPP9ZlXyag538kqQI,4075
-floodmodeller_api/test/test_dat.py,sha256=2xHgIrRPpc7HSrigRLKE9G3ATpzO-3kglGzmJsHo_8g,14347
+floodmodeller_api/test/test_dat.py,sha256=3-uQLydWsakqAZ50xIPvQGfDYlXklqp_8RQTb4TDSnE,14661
 floodmodeller_api/test/test_flowtimeprofile.py,sha256=yB70e_1SEjfbk1mmqtGRWHt8KYs_FgFjHfdUiAGWR0g,4114
+floodmodeller_api/test/test_fmfile.py,sha256=RTe1Rpy1sRK-_QzStrTJe7GNlC0ruURMdkoHZ2kozrY,550
 floodmodeller_api/test/test_hydrology_plus_export.py,sha256=USY-mqqNkmagkd_gfKGGj0ZTASQHQ30LKRBFBKTKKaw,7350
 floodmodeller_api/test/test_ied.py,sha256=VRscnsFPdYEVHNeJpUZW-ftUKvSBl4y_NjjsLXOJ8Zo,1117
-floodmodeller_api/test/test_ief.py,sha256=EPOJ6RgEzakQft0LakwHzB51FhW7EBzkwuZDODErG04,6195
+floodmodeller_api/test/test_ief.py,sha256=uhcljtMgyW2wAx9T7Ccq37hvQAYVZlTiSVz7kea2cXs,8377
 floodmodeller_api/test/test_inp.py,sha256=2KYo3cgvngZrXblL8Xtqpl2bJS9nCOog3rDtqHem3gg,1493
 floodmodeller_api/test/test_integrated_bridge.py,sha256=m81pA5AQpfVPvG8OX9NlsXD_8Z8MIoa8SIGrdmTMV28,5157
 floodmodeller_api/test/test_json.py,sha256=EMTOAbBnmGuH8AwLV526dxyhvrcDX1icpv7D6e1uXtI,4247
-floodmodeller_api/test/test_logs_lf.py,sha256=wAb4W3V4PRyEm-7sNeXRnWk0Kcf7GKqZneT8GxW3v-A,3952
+floodmodeller_api/test/test_logs_lf.py,sha256=gODj_Ysm_hf-upScPKpCDkuoTZFUgr5-FdB5hM7Y2iw,5290
 floodmodeller_api/test/test_read_file.py,sha256=EcIOf37-1ZGcx5bzUkrAWUkrjrHOoJU-71KqG-UUTwA,778
 floodmodeller_api/test/test_river.py,sha256=hZXATFm2chYr0OlJQgEsa30o__X-hhGSvKYpV7iWlQU,8620
+floodmodeller_api/test/test_sluice.py,sha256=-t_3k2QZahJCTG3U60buUfFpUfA0ANngRABhMb8oM1w,1241
 floodmodeller_api/test/test_tool.py,sha256=izvi9YF4hVqP57uVFkmBMD2wJvd93LeIo7XF-JZ2RZM,4245
 floodmodeller_api/test/test_toolbox_structure_log.py,sha256=43RUYsmGIyavg5YrmXgaE1iFo35s7iKnp6cK1BzgdsY,6701
+floodmodeller_api/test/test_unit.py,sha256=PNyJDwhlVfT0nMWLrhi8HeeM7dstRPRlzse9fZgTl0o,1934
 floodmodeller_api/test/test_xml2d.py,sha256=pMwNySpxuCkidFimdD-0kQSYGc3jJFdak98nUZGwmqo,5149
 floodmodeller_api/test/test_zz.py,sha256=DVmossrrOI5fnXi8V8KWvzCmgOaZeobxcxT7G7OY53s,4414
 floodmodeller_api/test/test_data/7082.ief,sha256=IfH9Oybu3Mwemt1WLjLF_B3_7gud4O673R4QajvUIuU,748
@@ -134,6 +137,7 @@ floodmodeller_api/test/test_data/example5.inp,sha256=QFvmwBbYbELBExe-n-QoGzOreEl
 floodmodeller_api/test/test_data/example6.inp,sha256=dSLr6vCG-a5bFxWIPGKGWysn638mO6LdjDBqi4bFATQ,6274
 floodmodeller_api/test/test_data/example_h+_export.csv,sha256=uakQjcVVCbafCOAhPuoT-Zgkf-9HyvJ4GHubB-ZzFjs,9049
 floodmodeller_api/test/test_data/expected_conveyance.csv,sha256=JzUbMw0EbM6uelMUbly8S5uUl3V_XvWEwZAKIz2z_94,7302
+floodmodeller_api/test/test_data/floodplain.dat,sha256=OjS-1KObXvNqUdojCIuVVAkknh6gOKUspQfXSBul0so,1621
 floodmodeller_api/test/test_data/hplus_export_example_1.csv,sha256=Gsi5PsSMcup9M1K26y8B9pA3dSQeg585OYK6aZSlyZo,5218
 floodmodeller_api/test/test_data/hplus_export_example_10.csv,sha256=-GGFrcG4JLRoRxKCEA7Rw0FpgjLo2HYaRRDknhXdIuw,9124
 floodmodeller_api/test/test_data/hplus_export_example_2.csv,sha256=a9FLsEC5vrUH94Jy5xwd85IA59qM_0MoyAXo4WtX-38,9219
@@ -146,6 +150,8 @@ floodmodeller_api/test/test_data/hplus_export_example_8.csv,sha256=FR85MhtRuiBUt
 floodmodeller_api/test/test_data/hplus_export_example_9.csv,sha256=FR85MhtRuiBUtB_5GrrqGBaMvOZn3LSNupHsSzInMps,18352
 floodmodeller_api/test/test_data/integrated_bridge.dat,sha256=H8T9mLkRZWyXqy0obo6nThFvPAv1tAXT0ULL7sn1lcY,1196
 floodmodeller_api/test/test_data/jump.dat,sha256=MnTs3xHJkZNPkNs0a7G-rSz5r51hmYNnREwyocVuohY,4737
+floodmodeller_api/test/test_data/lf_complex_ex.lf1,sha256=a5e3WH0kcfF_TQPMu3VNS30a--uzq3jmrCxSYvFymUA,1726589
+floodmodeller_api/test/test_data/multievent.ief,sha256=uqHUoKtqikaxxAeZY5mwnvDgOVEDlLH8qgroQ_8r7Sc,767
 floodmodeller_api/test/test_data/network.dat,sha256=vULB-pUNwRWTfzDEQSaVgkp5FWnyrgCC3PORbgVwu0A,82923
 floodmodeller_api/test/test_data/network.ext,sha256=7z7-mNqWkJETpMASav3BRGq_3DqJd9l5Mnv7DqGtECk,493
 floodmodeller_api/test/test_data/network.exy,sha256=i-lJ0rm0ZEKnF8Hs3qw5dYcgcVzvcvexE8TLxuvmjb0,85
@@ -214,8 +220,8 @@ floodmodeller_api/toolbox/model_build/structure_log/structure_log.py,sha256=7Ny7
 floodmodeller_api/toolbox/model_conversion/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 floodmodeller_api/toolbox/model_review/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 floodmodeller_api/toolbox/results_analysis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-floodmodeller_api/units/__init__.py,sha256=HJQaIgi0E3y8OhbYIDfZx8lHV4M2J2ebCgrOKnvTXpI,1030
-floodmodeller_api/units/_base.py,sha256=KihWO_E1KmFxjfeNhJwL_heKm57i3AjXSP01Iyqjmzk,10829
+floodmodeller_api/units/__init__.py,sha256=aoWw79JGXL1Yonz-9HM43CeOV_fGrf6rvd4Rrs5BTAE,1059
+floodmodeller_api/units/_base.py,sha256=rIVK-gz1g92njdx52Kt3C-yj--hsqrd2trKkRJfKtWY,11106
 floodmodeller_api/units/_helpers.py,sha256=KqH9Qn6_mGB-TQBPkObb1_DRGfpvwdKqdA1iYFtAMuc,10918
 floodmodeller_api/units/boundaries.py,sha256=YW3Gact2CDvENkmI5ttka_fMJB131stYAoReIF4b3fI,19135
 floodmodeller_api/units/comment.py,sha256=KFaPuypi4RfkSPVwFuyLG1AtiBhlcliptWXp7Bo45R0,1864
@@ -225,9 +231,9 @@ floodmodeller_api/units/controls.py,sha256=zwK9qcJex2lcZFbA9XW0ks1-CFn8TGJglpV_q
 floodmodeller_api/units/conveyance.py,sha256=yx-6DZfz4VHPi_ho0ZWkMM4Z79qFwmri1HW-YcxTkE8,6324
 floodmodeller_api/units/iic.py,sha256=3fl_90HETaIdVSlJexBKiLtJ473sT4UEusS1k5Dd-WY,3408
 floodmodeller_api/units/losses.py,sha256=pl5eNKUmnWjmyH03B0A5YhzgLTn1APuXYgr1VIrSut8,11972
-floodmodeller_api/units/sections.py,sha256=ujXCM3MgEk0SJ9v6--SbTYA664MbH5cgXcBeZfUbBQU,19789
-floodmodeller_api/units/structures.py,sha256=vllzJ-TxVuDqDnAhq12ieiP9Ka815q2HbNxJKSM_-SQ,61666
-floodmodeller_api/units/units.py,sha256=AwRA1aS0Hb9TcW1xo1AH2MsgXoedothb6h7X1vNEj0A,5331
+floodmodeller_api/units/sections.py,sha256=ntunzD9ePp3z2Qw5XKlwJ468EP7eOPC8ZoGEhpRawIM,19795
+floodmodeller_api/units/structures.py,sha256=3KsZs3XX3ztJv_HddONIiEDNdZ0Fp3Pw8kE8RFOuIAg,67375
+floodmodeller_api/units/units.py,sha256=WFWD4kvCJNstHeN553zTdDHc_bFgRyHpIDSAd6zv-10,5309
 floodmodeller_api/units/unsupported.py,sha256=TtNJjLiJt1dqYmIYxj799TM5HXjN_imR51CkzkK7B9I,1770
 floodmodeller_api/units/variables.py,sha256=g1VCxgJbd5Tv9Njn4B_UBTo1Sa8eBP3j8Efko8p0lgI,3061
 floodmodeller_api/urban1d/__init__.py,sha256=7-_TpJTV8N2SoTEOpHUo0pi87ue8BqBii5FldTc_SjA,192
@@ -241,12 +247,12 @@ floodmodeller_api/urban1d/raingauges.py,sha256=8TbptV7-yNi8-u8vfsvyIXoXDLq0SlgcU
 floodmodeller_api/urban1d/subsections.py,sha256=TR47UaFt7XgpL1aqDVDzUaEwmOD8QcX8nfPn7AQ9RGo,2976
 floodmodeller_api/urban1d/xsections.py,sha256=49n08yE4WfxPzPy72mi0NJWG46p--I2ZmZhLUCQ67Gg,5481
 floodmodeller_api/validation/__init__.py,sha256=sUMqShUGLnuQjmxKN3wAR7XpDVYsSFn4gWT63awXjOU,39
-floodmodeller_api/validation/parameters.py,sha256=37a0w9J1z8e8kzWhosF54ZcmGDlmGZYbxczLd41cVdI,16194
+floodmodeller_api/validation/parameters.py,sha256=VG6wlDiA5A5cm3TEhYCJ4dNqzm8Hl1X7CMpohBIdOjQ,16585
 floodmodeller_api/validation/urban_parameters.py,sha256=tD4ORsexmvvVZhDxbRyDlYyEH4uswySxiTIs2JWZwKs,11391
 floodmodeller_api/validation/validation.py,sha256=rwNNmUP2VSfv196Iv6HbGI-PeC_YxTCQM_4stcEB5lk,4665
-floodmodeller_api-0.5.2.post1.dist-info/LICENSE.txt,sha256=las1guEzggQukja_R_nI5E6jGEYEnpQdJoTZvup2e5E,920
-floodmodeller_api-0.5.2.post1.dist-info/METADATA,sha256=XKY3LmmhXC7fnLu1CLZSEcrLKZLOKFGrvp6d1wWvkmo,5603
-floodmodeller_api-0.5.2.post1.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-floodmodeller_api-0.5.2.post1.dist-info/entry_points.txt,sha256=RQFzb_zf1hNv2uNRfoCD3nRzyzGi8vPvj7VGOhrOjtI,198
-floodmodeller_api-0.5.2.post1.dist-info/top_level.txt,sha256=x10nxct120kv2PpqYA2lhiwrYre3wKyic2wcUyNWWRw,18
-floodmodeller_api-0.5.2.post1.dist-info/RECORD,,
+floodmodeller_api-0.5.3.post1.dist-info/licenses/LICENSE.txt,sha256=las1guEzggQukja_R_nI5E6jGEYEnpQdJoTZvup2e5E,920
+floodmodeller_api-0.5.3.post1.dist-info/METADATA,sha256=pl4oOBBBx1iWjPPPntrLJU0-YCyiZ_o5Zihs97aseZo,5794
+floodmodeller_api-0.5.3.post1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+floodmodeller_api-0.5.3.post1.dist-info/entry_points.txt,sha256=RQFzb_zf1hNv2uNRfoCD3nRzyzGi8vPvj7VGOhrOjtI,198
+floodmodeller_api-0.5.3.post1.dist-info/top_level.txt,sha256=x10nxct120kv2PpqYA2lhiwrYre3wKyic2wcUyNWWRw,18
+floodmodeller_api-0.5.3.post1.dist-info/RECORD,,

{floodmodeller_api-0.5.2.post1.dist-info → floodmodeller_api-0.5.3.post1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.1.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any