From 4a3c48dd01bc1ddb39bbfb76996684b01f5fb233 Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Thu, 12 Dec 2024 17:48:00 +0100 Subject: [PATCH 1/3] Hybrid navigation again --- docs/_quarto.yml | 108 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 78 insertions(+), 30 deletions(-) diff --git a/docs/_quarto.yml b/docs/_quarto.yml index 469daf756..99b4bb31f 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -22,18 +22,25 @@ website: left: - href: index.qmd text: Home + - href: user-guide/getting-started.qmd + text: "User Guide" - href: examples/index.qmd text: Examples - href: api/index.qmd text: API Reference + # use hybrid navigation + sidebar: - style: docked - search: true - contents: - - section: "User Guide" - href: user-guide/getting-started.qmd - contents: + + - title: Home + style: docked + contents: + - index.qmd + + + - title: "User Guide" + contents: - user-guide/getting-started.qmd - user-guide/data-structures.md - user-guide/dataarray.qmd @@ -46,29 +53,70 @@ website: - user-guide/eum.qmd - user-guide/generic.qmd - user-guide/pfs.qmd - - section: Examples - href: examples/index.qmd - contents: - - section: Dfs0 - href: examples/dfs0/index.qmd - contents: - - examples/dfs0/cmems_insitu.qmd - - section: Dfs2 - href: examples/dfs2/index.qmd - contents: - - examples/dfs2/bathy.qmd - - examples/dfs2/gfs.qmd - - section: Dfsu - href: examples/dfsu/index.qmd - contents: - - examples/dfsu/spatial_interpolation.qmd - - examples/dfsu/merge_subdomains.qmd - - examples/Time-interpolation.qmd - - examples/Generic.qmd - - text: Design philosophy - href: design.qmd - - text: API Reference - href: api/index.qmd + + - title: Examples + contents: + - examples/index.qmd + - examples/dfs0/index.qmd + - examples/dfs2/index.qmd + - examples/dfsu/index.qmd + - examples/Time-interpolation.qmd + - examples/Generic.qmd + - title: "API Reference" + contents: + - api/index.qmd + - api/DataArray.qmd + - api/Dataset.qmd + - api/Dfs0.qmd + - api/Dfs1.qmd + - api/Dfs2.qmd + - api/Dfs3.qmd + - api/Dfsu.qmd + + + + # sidebar: + # style: docked + # search: true + # contents: + # - section: "User Guide" + # href: user-guide/getting-started.qmd + # contents: + # - user-guide/getting-started.qmd + # - user-guide/data-structures.md + # - user-guide/dataarray.qmd + # - user-guide/dataset.qmd + # - user-guide/dfs0.qmd + # - user-guide/dfs1.qmd + # - user-guide/dfs2.qmd + # - user-guide/dfsu.qmd + # - user-guide/mesh.qmd + # - user-guide/eum.qmd + # - user-guide/generic.qmd + # - user-guide/pfs.qmd + # - section: Examples + # href: examples/index.qmd + # contents: + # - section: Dfs0 + # href: examples/dfs0/index.qmd + # contents: + # - examples/dfs0/cmems_insitu.qmd + # - section: Dfs2 + # href: examples/dfs2/index.qmd + # contents: + # - examples/dfs2/bathy.qmd + # - examples/dfs2/gfs.qmd + # - section: Dfsu + # href: examples/dfsu/index.qmd + # contents: + # - examples/dfsu/spatial_interpolation.qmd + # - examples/dfsu/merge_subdomains.qmd + # - examples/Time-interpolation.qmd + # - examples/Generic.qmd + # - text: Design philosophy + # href: design.qmd + # - text: API Reference + # href: api/index.qmd @@ -174,4 +222,4 @@ format: toc: true ipynb: theme: cosmo - toc: true + toc: true \ No newline at end of file From cbdc1e97303fd48034d888e5fffa4458ce16af2e Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Mon, 16 Dec 2024 08:27:05 +0100 Subject: [PATCH 2/3] Add dataset plotter to the dataset module --- mikeio/dataset/__init__.py | 29 ++++++++++++++++++++++++++++- mikeio/dataset/_data_plot.py | 14 ++++++++++++++ 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/mikeio/dataset/__init__.py b/mikeio/dataset/__init__.py index 4f75543dc..b56dfd841 100644 --- a/mikeio/dataset/__init__.py +++ b/mikeio/dataset/__init__.py @@ -1,4 +1,31 @@ from ._dataarray import DataArray from ._dataset import Dataset, from_pandas, from_polars +from ._data_plot import ( + _DataArrayPlotter, + _DataArrayPlotterGrid1D, + _DataArrayPlotterGrid2D, + _DataArrayPlotterFM, + _DataArrayPlotterFMVerticalColumn, + _DataArrayPlotterFMVerticalProfile, + _DataArrayPlotterPointSpectrum, + _DataArrayPlotterLineSpectrum, + _DataArrayPlotterAreaSpectrum, + _DatasetPlotter, +) -__all__ = ["DataArray", "Dataset", "from_pandas", "from_polars"] +__all__ = [ + "DataArray", + "Dataset", + "from_pandas", + "from_polars", + "_DataArrayPlotter", + "_DataArrayPlotterGrid1D", + "_DataArrayPlotterGrid2D", + "_DataArrayPlotterFM", + "_DataArrayPlotterFMVerticalColumn", + "_DataArrayPlotterFMVerticalProfile", + "_DataArrayPlotterPointSpectrum", + "_DataArrayPlotterLineSpectrum", + "_DataArrayPlotterAreaSpectrum", + "_DatasetPlotter", +] diff --git a/mikeio/dataset/_data_plot.py b/mikeio/dataset/_data_plot.py index 214ad9684..153769685 100644 --- a/mikeio/dataset/_data_plot.py +++ b/mikeio/dataset/_data_plot.py @@ -925,3 +925,17 @@ def scatter( @staticmethod def _label_txt(da: DataArray) -> str: return f"{da.name} [{da.unit.name}]" + + +__all__ = [ + "_DataArrayPlotter", + "_DataArrayPlotterGrid1D", + "_DataArrayPlotterGrid2D", + "_DataArrayPlotterFM", + "_DataArrayPlotterFMVerticalColumn", + "_DataArrayPlotterFMVerticalProfile", + "_DataArrayPlotterPointSpectrum", + "_DataArrayPlotterLineSpectrum", + "_DataArrayPlotterAreaSpectrum", + "_DatasetPlotter", +] From d4cff3bc222a8cdc4ad9d38d003d3b957993a65e Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Mon, 16 Dec 2024 08:27:14 +0100 Subject: [PATCH 3/3] Pretty index page --- docs/MIKE-IO-Logo-Pos-RGB.svg | 2 +- docs/_quarto.yml | 73 +++++------------------------ docs/index.qmd | 50 +++++++++++--------- docs/license.qmd | 26 ++++++++++ docs/user-guide/getting-started.qmd | 12 +++++ 5 files changed, 79 insertions(+), 84 deletions(-) create mode 100644 docs/license.qmd diff --git a/docs/MIKE-IO-Logo-Pos-RGB.svg b/docs/MIKE-IO-Logo-Pos-RGB.svg index 6fb34d7bf..7346b0f0a 100644 --- a/docs/MIKE-IO-Logo-Pos-RGB.svg +++ b/docs/MIKE-IO-Logo-Pos-RGB.svg @@ -1,7 +1,7 @@ + viewBox="20 20 194.8 59.5" style="enable-background:new 0 0 234.8 99.5;" xml:space="preserve">