Floodmodeller-api

What's new in 0.5.2 (February 2025)

This page details the changes for version 0.5.2 of Flood Modeller API

New features
- New integrated `BRIDGE` unit type added
- New supported units: `RESERVOIR`, `JUNCTION` and `LATERAL`
- Return DAT units as a network using `DAT.get_network`

Updates
- Improved logging
- Make `LF.to_dataframe` behave more like `ZZ.to_dataframe`
- Lots of general improvements to clean and tidy up the codebase


Bug fixes
- Fix log path handling in IEF class
- Fix file compatibility issues in linux

What's Changed
* change from black to ruff formatter by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/159
* urban1d: change duplication of normal to tidal by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/158
* Superbridge by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/143
* Make `LF.to_dataframe` more like `ZZ.to_dataframe` by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/161
* Logging by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/145
* Tidy up TODO tags by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/151
* Junctions, lateral, reservoirs by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/163
* Change encoding to cp1252 by ben-olin in https://github.com/People-Places-Solutions/floodmodeller-api/pull/168
* fix ief paths for linux by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/172
* fix log path in ief by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/174
* Create network nodes & edges from dat file by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/169

New Contributors
* ben-olin made their first contribution in https://github.com/People-Places-Solutions/floodmodeller-api/pull/168

**Full Changelog**: https://github.com/People-Places-Solutions/floodmodeller-api/compare/v0.5.0...v0.5.2

What's new in 0.5.1 (November 2024)
This page details the changes for version 0.5.1 of Flood Modeller API

New features
* ZZX class added to support reading supplementary 1D data from Flood Modeller *.zzx files

Updates
* Updates to the structure log tool
* Added new public attributes for `FMUnit` and `FMFile` subclasses: `.unit`, `.filetype` and `.filepath`

Bug fixes
* Fix section `data` property setter method to allow overwriting the section data directly.

Merged PRs
* suppress specific warnings by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/131
* 130 section data setter fix by jacob-toller in https://github.com/People-Places-Solutions/floodmodeller-api/pull/132
* Fix language by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/138
* 95 add zzx class by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/135
* Structure log update by jacob-toller in https://github.com/People-Places-Solutions/floodmodeller-api/pull/141
* Structure log update by jacob-toller in https://github.com/People-Places-Solutions/floodmodeller-api/pull/142

New Contributors
* jacob-toller made their first contribution in https://github.com/People-Places-Solutions/floodmodeller-api/pull/132

**Full Changelog**: https://github.com/People-Places-Solutions/floodmodeller-api/compare/v0.5.0...v0.5.1

What's new in 0.5.0 (September 2024)

This page details the changes for version 0.5.0 of Flood Modeller Python API

New features

- [Hydrology+ support](https://api.floodmodeller.com/api/user_guide/hydrology_plus.html) - users can now use the API to load exported Hydrology+ data from Flood Modeller to read the data or generate new simulations programmatically.

Updates

- Added `floodmodeller_api.units.RIVER.active_data` property to the `RIVER` class to allow quick access to the activated subset of the data ([issue](https://github.com/People-Places-Solutions/floodmodeller-api/issues/120)).
- Added `floodmodeller_api.IEF.flowtimeprofiles` attribute to `IEF` class to allow better support for flow time profile data. [See more info here](flowtimeprofile_section).
- [Speed improvements to conveyance calculation](https://github.com/People-Places-Solutions/floodmodeller-api/issues/117) to allow conveyance for even very large sections to be calculated very fast.
- [Support for comments in IEDs](https://github.com/People-Places-Solutions/floodmodeller-api/pull/127).
- Increased test coverage and lots of code improvements under the hood!

Bug fixes

- Fixed an issue related to HTBDY units in models from legacy versions of Flood Modeller ([issue](https://github.com/People-Places-Solutions/floodmodeller-api/issues/16)).


Merged PRs
* Fix legacy HTBDY option in wrong column by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/119
* 120 get active section data by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/121
* update ruff version by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/126
* 118 ief from blank reads attributes explicitly as by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/122
* Ied comment support by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/127
* Optimise conveyance by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/123
* 116 hydrology plus by VicCabPo in https://github.com/People-Places-Solutions/floodmodeller-api/pull/124
* Remove some noqa by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/129


**Full Changelog**: https://github.com/People-Places-Solutions/floodmodeller-api/compare/v0.4.4...v0.5.0

What's Changed
* update reqs by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/111
* Bump tqdm from 4.66.2 to 4.66.3 by dependabot in https://github.com/People-Places-Solutions/floodmodeller-api/pull/110
* decorator for exception handling by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/109
* 113 implement cross section conveyance calculation by joe-pierce in https://github.com/People-Places-Solutions/floodmodeller-api/pull/115


**Full Changelog**: https://github.com/People-Places-Solutions/floodmodeller-api/compare/v0.4.3...v0.4.4

What's Changed
* pyproject.toml & ruff by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/91
* Bump black from 23.9.1 to 24.3.0 by dependabot in https://github.com/People-Places-Solutions/floodmodeller-api/pull/99
* TUFLOW HPC linked models in LF1 by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/101
* ZZN binaries by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/102
* 93 tofrom json methods by VicCabPo in https://github.com/People-Places-Solutions/floodmodeller-api/pull/98
* DAT insert many by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/103
* regex test fix by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/105
* update button to be able to resume codespace by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/106
* prep pipelines by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/107
* error message for LD_LIBRARY_PATH by scleakey in https://github.com/People-Places-Solutions/floodmodeller-api/pull/108
* reviews and merging by joe-pierce

New Contributors
* dependabot made their first contribution in https://github.com/People-Places-Solutions/floodmodeller-api/pull/99
* VicCabPo made their first contribution in https://github.com/People-Places-Solutions/floodmodeller-api/pull/98

**Full Changelog**: https://github.com/People-Places-Solutions/floodmodeller-api/compare/v0.4.2.post1...v0.4.3

Minor fix to address issue when writing generated HTBDY units.