Merge branch 'main' into geometryFM_contains_shapely

Author: ecomodeller

.github/workflows/build_docs.yml

@@ -13,7 +13,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
 
     - name: Install dependencies
       run: |

.github/workflows/docs.yml

@@ -17,11 +17,13 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: [3.8, "3.12"]
+        python-version: [3.9, "3.12"]
 
     steps:
     - uses: actions/checkout@v3
     - uses: chartboost/ruff-action@v1 # Fail fast if there are any linting errors
+      with:
+        version: 0.5.6 # consistent with pyproject.toml ?
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:

.github/workflows/full_test.yml

@@ -17,16 +17,13 @@ jobs:
         - name: Set up Python
           uses: actions/setup-python@v4
           with:
-            python-version: 3.8
-
-        - name: Install older dependencies
-          run: |
-            python -m pip install --upgrade pip
-            pip install -r requirements_min.txt
-            pip install pytest
+            python-version: 3.9
+              
         - name: Install MIKE IO
           run: |
+            python -m pip install --upgrade pip
             pip install .[test]
+            pip install -r requirements_min.txt
         - name: Test with pytest
           run: |
             pytest --ignore tests/notebooks/

.github/workflows/legacy_test.yml

@@ -25,6 +25,7 @@ cov_annotate
 htmlcov
 
 docs/_site
+docs/user-guide/*.dfs*
 
 # generated by quartodoc
 docs/api/
@@ -33,4 +34,5 @@ docs/api/
 .venv/
 
 .testmondata
-objects.json
+objects.json
+.jupyter_cache/

.gitignore

@@ -7,6 +7,16 @@
 ![OS](https://img.shields.io/badge/OS-Windows%20%7C%20Linux-blue)
 
 
+> [!NOTE]
+> 
+> ![](https://training.dhigroup.com/ACA_Logo.png?v=1647618443406)
+>
+> **Instructor-led course**
+>
+> [Getting started with MIKE IO for Python processing of dfs files](https://training.dhigroup.com/event/sessions?id=Instructor-led_course_-_Online852475847)
+> 
+> From 4th September 2024 to 2nd October 2024
+
 Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files.
 
 MIKE IO facilitates common data processing workflows for [MIKE files in Python](https://www.mikepoweredbydhi.com/products/mike-for-developers#io).
@@ -18,7 +28,7 @@ MIKE IO facilitates common data processing workflows for [MIKE files in Python](
 
 ## Requirements
 * Windows or Linux operating system
-* Python x64 3.8 - 3.12
+* Python x64 3.9 - 3.12
 * (Windows) [VC++ redistributables](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) (already installed if you have MIKE)
 
 [More info about dependencies](http://docs.mikepoweredbydhi.com/nuget/)
@@ -51,46 +61,51 @@ MIKE IO is tested extensively.
 
 See detailed test coverage report below:
 ```
----------- coverage: platform linux, python 3.11.1-final-0 -----------
-Name                              Stmts   Miss  Cover
------------------------------------------------------
-mikeio/__init__.py                   38      2    95%
-mikeio/base.py                       26      5    81%
-mikeio/data_utils.py                111      5    95%
-mikeio/dataarray.py                 992    152    85%
-mikeio/dataset.py                   772    100    87%
-mikeio/dfs0.py                      299     24    92%
-mikeio/dfs1.py                       67      3    96%
-mikeio/dfs2.py                      188      8    96%
-mikeio/dfs3.py                      186     26    86%
-mikeio/dfs.py                       288     36    88%
-mikeio/dfsu/__init__.py               3      0   100%
-mikeio/dfsu/dfsu.py                 592     56    91%
-mikeio/dfsu/factory.py               41      2    95%
-mikeio/dfsu/layered.py              180     20    89%
-mikeio/dfsu/spectral.py             127      6    95%
-mikeio/dfsutil.py                   129     15    88%
-mikeio/eum.py                      1324     12    99%
-mikeio/exceptions.py                 25      8    68%
-mikeio/generic.py                   433     16    96%
-mikeio/interpolation.py              60      5    92%
-mikeio/pfs/__init__.py                4      0   100%
-mikeio/pfs/pfsdocument.py           242     16    93%
-mikeio/pfs/pfssection.py            220      9    96%
-mikeio/spatial/FM_geometry.py      1118    102    91%
-mikeio/spatial/FM_utils.py          293     30    90%
-mikeio/spatial/__init__.py            0      0   100%
-mikeio/spatial/crs.py                50      4    92%
-mikeio/spatial/geometry.py           90     33    63%
-mikeio/spatial/grid_geometry.py     558     42    92%
-mikeio/spatial/utils.py              38      0   100%
-mikeio/spectral.py                   90      5    94%
-mikeio/track.py                     100     14    86%
-mikeio/xyz.py                        12      0   100%
------------------------------------------------------
-TOTAL                              8696    756    91%
-
-=========== 697 passed, 3 warnings in 46.01s ========
+---------- coverage: platform linux, python 3.12.4-final-0 -----------
+Name                                      Stmts   Miss  Cover
+-------------------------------------------------------------
+mikeio/__init__.py                           31      3    90%
+mikeio/_interpolation.py                     68      6    91%
+mikeio/_spectral.py                          97      7    93%
+mikeio/_time.py                              29      1    97%
+mikeio/_track.py                            103     14    86%
+mikeio/dataset/__init__.py                    3      0   100%
+mikeio/dataset/_data_plot.py                358     38    89%
+mikeio/dataset/_data_utils.py                20      0   100%
+mikeio/dataset/_dataarray.py                730     52    93%
+mikeio/dataset/_dataset.py                  734     57    92%
+mikeio/dfs/__init__.py                        5      0   100%
+mikeio/dfs/_dfs0.py                         198     13    93%
+mikeio/dfs/_dfs1.py                          58      2    97%
+mikeio/dfs/_dfs2.py                         132      3    98%
+mikeio/dfs/_dfs3.py                         147      9    94%
+mikeio/dfs/_dfs.py                          290     18    94%
+mikeio/dfsu/__init__.py                       6      0   100%
+mikeio/dfsu/_common.py                       36      1    97%
+mikeio/dfsu/_dfsu.py                        223      7    97%
+mikeio/dfsu/_factory.py                      20      1    95%
+mikeio/dfsu/_layered.py                     190      7    96%
+mikeio/dfsu/_mesh.py                         54      8    85%
+mikeio/dfsu/_spectral.py                    214     36    83%
+mikeio/eum/__init__.py                        2      0   100%
+mikeio/eum/_eum.py                         1334      9    99%
+mikeio/exceptions.py                         24      4    83%
+mikeio/generic.py                           451     17    96%
+mikeio/pfs/__init__.py                        8      0   100%
+mikeio/pfs/_pfsdocument.py                  248     13    95%
+mikeio/pfs/_pfssection.py                   223      9    96%
+mikeio/spatial/_FM_geometry.py              521     24    95%
+mikeio/spatial/_FM_geometry_layered.py      415     30    93%
+mikeio/spatial/_FM_geometry_spectral.py      94      9    90%
+mikeio/spatial/_FM_utils.py                 275     22    92%
+mikeio/spatial/__init__.py                    6      0   100%
+mikeio/spatial/_geometry.py                  78      8    90%
+mikeio/spatial/_grid_geometry.py            639     45    93%
+mikeio/spatial/_utils.py                     39      0   100%
+mikeio/spatial/crs.py                        51      5    90%
+mikeio/xyz.py                                14      0   100%
+-------------------------------------------------------------
+TOTAL                                      8168    478    94%
 ```
 
 ## Cloud enabled

README.md

@@ -98,6 +98,8 @@ quartodoc:
         - open
         - read
         - read_pfs
+        - from_pandas
+        - from_polars
     - title: Dataset
       desc: ""
       contents:
@@ -109,6 +111,7 @@ quartodoc:
         - dataset._data_plot._DataArrayPlotterGrid2D
         - dataset._data_plot._DataArrayPlotterFM
         - dataset._data_plot._DataArrayPlotterFMVerticalProfile
+        - dataset._data_plot._DataArrayPlotterFMVerticalColumn
     - title: Geometry
       desc: ""
       contents:

docs/_quarto.yml

@@ -5,6 +5,16 @@
  ![Python version](https://img.shields.io/pypi/pyversions/mikeio.svg)
 [![PyPI version](https://badge.fury.io/py/mikeio.svg)](https://badge.fury.io/py/mikeio)
 
+::: callout-note
+![](https://training.dhigroup.com/ACA_Logo.png?v=1647618443406)
+
+**Instructor-led course**
+
+[Getting started with MIKE IO for Python processing of dfs files](https://training.dhigroup.com/event/sessions?id=Instructor-led_course_-_Online852475847)
+ 
+From 4th September 2024 to 2nd October 2024
+:::
+
 Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files. 
 
 See our sister library [MIKE IO 1D](https://github.com/DHI/mikeio1d) for .res1d and .xns11 files.

docs/index.qmd

@@ -1,10 +1,9 @@
 ---
+title: DataArray
 aliases:
   - ../dataarray.html
 ---
 
-# DataArray
-
 The [DataArray](`mikeio.DataArray`) is the common MIKE IO data structure 
 for *item* data from dfs files. 
 The [](`mikeio.read`) methods returns a Dataset as a container of DataArrays (Dfs items)

docs/user-guide/dataarray.qmd

@@ -1,10 +1,9 @@
 ---
+title: Dataset
 aliases:
   - ../dataset.html
 ---
 
-# Dataset
-
 The [Dataset](`mikeio.Dataset`) is the MIKE IO data structure 
 for data from dfs files. 
 The [](`mikeio.read`) methods returns a Dataset as a container of [DataArray](`mikeio.DataArray`) (Dfs items). Each DataArray has the properties, *item*, *time*, *geometry* and *values*. The time and geometry are common to all DataArrays in the Dataset.