Merge pull request #84 from Deltares/dev/2.3.2

Dev/2.3.2

.github/workflows/ci.yml

@@ -66,4 +66,4 @@ jobs:
           args: >
             -Dsonar.organization=deltares
             -Dsonar.projectKey=Deltares_Fm2Prof
-            -Dsonar.python.coverage.reportPaths=.coverage-reports/coverage.xml
+            -Dsonar.python.coverage.reportPaths=.coverage-reports/coverage.xml

.gitignore

@@ -7,4 +7,6 @@
 /docs/build
 /dist
 /build
-/documentation
+/documentation
+
+*.log

docs/CHANGELOG.md

@@ -1,3 +1,40 @@
+## v2.3.1 (24-04-2024)
+
+**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
+
+
+## v2.3.0 (19-04-2024)
+
+### 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`
+
+
+
 ## v2.2.8 (2023-10-03)
 
 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. 

docs/markdown/utils.md

@@ -0,0 +1,9 @@
+# Utilities API
+
+FM2PROF includes a set of utilities to analyse its output. 
+
+## Compare1D2D
+
+::: fm2prof.utils.Compare1D2D
+    options:
+        inherited_members: false

fm2prof/Fm2ProfRunner.py

@@ -40,12 +40,13 @@ class Fm2ProfRunner(FM2ProfBase):
         iniFilePath (str): path to configuration file
     """
 
-    def __init__(self, iniFilePath: str = ""):
+    def __init__(self, iniFilePath: Path | str = ""):
         """
         Initializes the project
 
-        iniFilePath (str): path to a configuration file. If not given,
-                               default values will be used.
+        Parameters:
+            iniFilePath: path to a configuration file. If not given,
+                                default values will be used.
         """
         self.fm_model_data: FmModelData = None
         self._output_files: OutputFiles = OutputFiles()
@@ -1107,7 +1108,7 @@ def set_output_directory(self, path) -> None:
         """
         self.get_inifile().set_output_directory(path)
 
-    def get_output_directory(self) -> None:
+    def get_output_directory(self) -> str:
         """
         Returns the current output directory
         """

fm2prof/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "2.3.1"
+__version__ = "2.3.2"
 
 from fm2prof.Fm2ProfRunner import Project