Fm2prof

This release focuses on improving the `fm2prof.utils` tooling

New functionality

- `utils.Compare1D2D` has new option to output a `last25` and `max13` longitudinal view, and to combine the output of several simulations into a single figure (65). The docs have been updated with a notebook to showcase this new functionality. See User Manual -> Utilities

Documentation

- added notebooks to documentation that describe the use of some utilities


Changes

- added new `sito_2024` `PlotStyle` that is now default for `Compare1D2D` (66)

Deprecations

- `Compare1D2D.figure_longitudinal_time` is now deprecated in favour of `Compare1D2D.figure_longitudinal` with `stat="time"` parameter

**Bug fixes**
- Fixed a bug that threw an exception if user did not specify a stop time when using `utils.Compare1D2D` (78)
- Fixed bug (81) that prevented executable from being build because of missing favico

**Documentation**
- added python snippets to quickstart tutorial

New functionality

- Configuration file now has a new `debug` section with debug specific parameters. This section includes two parameters previously in the general `parameters` section (`ExportMapFiles` and `CssSelection`) and the new `ExportCSSData`.
- new debug option `ExportCSSData` that when enabled output data to analyse cross-section generation.
- new option `ConveyanceDetectionMethod` to toggle between the previous way to detect storage (0) and a the new one (1, default).

Documentation

- documentation now includes a notebook specifying how output from `ExportCSSData` option can be used to analyse flow data
- docstrings of cross-section class updated to describe flow/storage separation methodology
- several chapters ported over from sphinx

bug fixes & chores
- added dedicated tests for cross-section class
- test coverage is now reported in Sonarcloud
- fixed bug that caused error while writing log

bug fixes & chores

- fixed bug in `utils` that threw an error when using matplotlib 3.7 or higher
- removed unused code blocks
- updated type hinting and code documentation of `CrossSection.py`

This version update FM2PROF to Python 3.10 or higher. It removes unused dependencies and updates the package system `poetry` to version 1.8.2. Due to this switch, the commitizen workflow is currently not used, and the documentation system switch from sphinx to mkdocs.

This is the first version to be published to [PyPi](https://pypi.org/project/fm2prof/2.2.8/), which means that FM2PROF can now be installed using pip

`pip install fm2prof`

Known issues:

- The executable is not available for this version.

This version adds the parameter `stoptime` to `utils.Compare1D2D` and makes both `starttime` and `stoptime` parameters optional. With these parameters users can crop the section of the results over which statistics will be computed and figures made.

- Fixed an issue where irregular station names like `MA_67.00Z` caused a sorting error in `utils.Compare1D2D`