FEMlium 0.1.0__tar.gz

femlium-0.1.0/AUTHORS

@@ -0,0 +1 @@
+Francesco Ballarin <francesco.ballarin@unicatt.it>

femlium-0.1.0/FEMlium.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: FEMlium
+Version: 0.1.0
+Summary: Interactive geographic plots of finite element data with folium
+Author-email: Francesco Ballarin <francesco.ballarin@unicatt.it>
+Maintainer-email: Francesco Ballarin <francesco.ballarin@unicatt.it>
+License: Copyright 2021-2025 FEMlium authors and contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: homepage, https://femlium.github.io
+Project-URL: repository, https://github.com/FEMlium/FEMlium
+Project-URL: issues, https://github.com/FEMlium/FEMlium/issues
+Project-URL: funding, https://github.com/sponsors/francesco-ballarin
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: branca
+Requires-Dist: folium>=0.12.0
+Requires-Dist: geojson
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pyproj
+Provides-Extra: backend-dolfinx
+Requires-Dist: fenics-dolfinx>=0.8.0; extra == "backend-dolfinx"
+Provides-Extra: backend-firedrake
+Requires-Dist: firedrake>=2025.4.0; extra == "backend-firedrake"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: isort; extra == "lint"
+Requires-Dist: nbqa; extra == "lint"
+Requires-Dist: ruff; extra == "lint"
+Requires-Dist: yamllint; extra == "lint"
+Provides-Extra: tests
+Requires-Dist: coverage[toml]; extra == "tests"
+Requires-Dist: nbvalx[unit-tests]; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Provides-Extra: tutorials
+Requires-Dist: gmsh; extra == "tutorials"
+Requires-Dist: meshio; extra == "tutorials"
+Requires-Dist: nbvalx[notebooks]; extra == "tutorials"
+Requires-Dist: viskex; extra == "tutorials"
+Dynamic: license-file
+
+## FEMlium – interactive visualization of finite element simulations on geographic maps with folium ##
+<img src="https://femlium.github.io/_images/FEMlium-logo.png" alt="FEMlium – interactive visualization of finite element simulations on geographic maps with folium" width="150px">
+
+**FEMlium** is a library that enables visualizing finite element simulations on geographic maps using **folium**. Supported finite element backends are dolfinx and firedrake.
+
+**FEMlium** is currently developed and maintained at [Università Cattolica del Sacro Cuore](https://www.unicatt.it/) by [Prof. Francesco Ballarin](https://www.francescoballarin.it).
+
+Like **folium**, **FEMlium** is freely available under the MIT license.
+
+Visit [femlium.github.io](https://femlium.github.io/) for installation instructions and additional information.

femlium-0.1.0/FEMlium.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+AUTHORS
+LICENSE
+README.md
+pyproject.toml
+FEMlium.egg-info/PKG-INFO
+FEMlium.egg-info/SOURCES.txt
+FEMlium.egg-info/dependency_links.txt
+FEMlium.egg-info/requires.txt
+FEMlium.egg-info/top_level.txt
+femlium/__init__.py
+femlium/base_mesh_plotter.py
+femlium/base_plotter.py
+femlium/base_solution_plotter.py
+femlium/dolfinx_plotter.py
+femlium/domain_plotter.py
+femlium/firedrake_plotter.py
+femlium/meshio_plotter.py
+femlium/numpy_plotter.py
+femlium/utils/__init__.py
+femlium/utils/colorbar_wrapper.py
+femlium/utils/geojson_with_arrows.py
+femlium/utils/transformer_wrapper.py

femlium-0.1.0/FEMlium.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

femlium-0.1.0/FEMlium.egg-info/requires.txt

@@ -0,0 +1,32 @@
+branca
+folium>=0.12.0
+geojson
+matplotlib
+numpy
+pyproj
+
+[backend_dolfinx]
+fenics-dolfinx>=0.8.0
+
+[backend_firedrake]
+firedrake>=2025.4.0
+
+[docs]
+sphinx
+
+[lint]
+isort
+nbqa
+ruff
+yamllint
+
+[tests]
+coverage[toml]
+nbvalx[unit-tests]
+pytest
+
+[tutorials]
+gmsh
+meshio
+nbvalx[notebooks]
+viskex

femlium-0.1.0/FEMlium.egg-info/top_level.txt

@@ -0,0 +1 @@
+femlium

femlium-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021-2025 FEMlium authors and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

femlium-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: FEMlium
+Version: 0.1.0
+Summary: Interactive geographic plots of finite element data with folium
+Author-email: Francesco Ballarin <francesco.ballarin@unicatt.it>
+Maintainer-email: Francesco Ballarin <francesco.ballarin@unicatt.it>
+License: Copyright 2021-2025 FEMlium authors and contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: homepage, https://femlium.github.io
+Project-URL: repository, https://github.com/FEMlium/FEMlium
+Project-URL: issues, https://github.com/FEMlium/FEMlium/issues
+Project-URL: funding, https://github.com/sponsors/francesco-ballarin
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: branca
+Requires-Dist: folium>=0.12.0
+Requires-Dist: geojson
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pyproj
+Provides-Extra: backend-dolfinx
+Requires-Dist: fenics-dolfinx>=0.8.0; extra == "backend-dolfinx"
+Provides-Extra: backend-firedrake
+Requires-Dist: firedrake>=2025.4.0; extra == "backend-firedrake"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: isort; extra == "lint"
+Requires-Dist: nbqa; extra == "lint"
+Requires-Dist: ruff; extra == "lint"
+Requires-Dist: yamllint; extra == "lint"
+Provides-Extra: tests
+Requires-Dist: coverage[toml]; extra == "tests"
+Requires-Dist: nbvalx[unit-tests]; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Provides-Extra: tutorials
+Requires-Dist: gmsh; extra == "tutorials"
+Requires-Dist: meshio; extra == "tutorials"
+Requires-Dist: nbvalx[notebooks]; extra == "tutorials"
+Requires-Dist: viskex; extra == "tutorials"
+Dynamic: license-file
+
+## FEMlium – interactive visualization of finite element simulations on geographic maps with folium ##
+<img src="https://femlium.github.io/_images/FEMlium-logo.png" alt="FEMlium – interactive visualization of finite element simulations on geographic maps with folium" width="150px">
+
+**FEMlium** is a library that enables visualizing finite element simulations on geographic maps using **folium**. Supported finite element backends are dolfinx and firedrake.
+
+**FEMlium** is currently developed and maintained at [Università Cattolica del Sacro Cuore](https://www.unicatt.it/) by [Prof. Francesco Ballarin](https://www.francescoballarin.it).
+
+Like **folium**, **FEMlium** is freely available under the MIT license.
+
+Visit [femlium.github.io](https://femlium.github.io/) for installation instructions and additional information.

femlium-0.1.0/README.md

@@ -0,0 +1,10 @@
+## FEMlium – interactive visualization of finite element simulations on geographic maps with folium ##
+<img src="https://femlium.github.io/_images/FEMlium-logo.png" alt="FEMlium – interactive visualization of finite element simulations on geographic maps with folium" width="150px">
+
+**FEMlium** is a library that enables visualizing finite element simulations on geographic maps using **folium**. Supported finite element backends are dolfinx and firedrake.
+
+**FEMlium** is currently developed and maintained at [Università Cattolica del Sacro Cuore](https://www.unicatt.it/) by [Prof. Francesco Ballarin](https://www.francescoballarin.it).
+
+Like **folium**, **FEMlium** is freely available under the MIT license.
+
+Visit [femlium.github.io](https://femlium.github.io/) for installation instructions and additional information.

femlium-0.1.0/femlium/__init__.py

@@ -0,0 +1,33 @@
+# Copyright (C) 2021-2025 by the FEMlium authors
+#
+# This file is part of FEMlium.
+#
+# SPDX-License-Identifier: MIT
+"""FEMlium main module."""
+
+from femlium.base_mesh_plotter import BaseMeshPlotter
+from femlium.base_plotter import BasePlotter
+from femlium.base_solution_plotter import BaseSolutionPlotter
+from femlium.domain_plotter import DomainPlotter
+from femlium.numpy_plotter import NumpyPlotter
+
+try:
+    import meshio
+except ImportError:  # pragma: no cover
+    pass
+else:
+    from femlium.meshio_plotter import MeshioPlotter
+
+try:
+    import dolfinx
+except ImportError:
+    pass
+else:
+    from femlium.dolfinx_plotter import DolfinxPlotter
+
+try:
+    import firedrake
+except ImportError:
+    pass
+else:
+    from femlium.firedrake_plotter import FiredrakePlotter

femlium-0.1.0/femlium/base_mesh_plotter.py

@@ -0,0 +1,263 @@
+# Copyright (C) 2021-2025 by the FEMlium authors
+#
+# This file is part of FEMlium.
+#
+# SPDX-License-Identifier: MIT
+"""Base interface of a geographic plotter for mesh-related plots."""
+
+import typing
+
+import folium
+import geojson
+import numpy as np
+import numpy.typing as npt
+
+from femlium.base_plotter import BasePlotter
+from femlium.utils import ColorbarWrapper
+
+
+class BaseMeshPlotter(BasePlotter):
+    """Base interface of a geographic plotter for mesh-related plots."""
+
+    def add_mesh_to(
+        self, geo_map: folium.Map, vertices: npt.NDArray[np.float64], cells: npt.NDArray[np.int64],
+        cell_markers: typing.Optional[npt.NDArray[np.int64]] = None,
+        face_markers: typing.Optional[npt.NDArray[np.int64]] = None,
+        cell_colors: typing.Optional[typing.Union[str, dict[int, str]]] = None,
+        face_colors: typing.Optional[typing.Union[str, dict[int, str]]] = None,
+        face_weights: typing.Optional[typing.Union[int, dict[int, int]]] = None
+    ) -> None:
+        """
+        Add a triangular mesh to a folium map.
+
+        Parameters
+        ----------
+        geo_map
+            Map to which the mesh plot should be added.
+        vertices
+            Matrix containing the coordinates of the vertices.
+            The matrix should have as many rows as vertices in the mesh, and two columns.
+        cells
+            Matrix containing the connectivity of the cells.
+            The matrix should have as many rows as cells in the mesh, and three columns.
+        cell_markers
+            Vector containing a marker (i.e., an integer number) for each cell.
+            The vector should have as many entries as cells in the mesh.
+            If not provided, the marker will be set to 0 everywhere.
+        face_markers
+            Matrix containing a marker (i.e., an integer number) for each face.
+            The matrix should have the same shape of the cells argument.
+            Given a row index r, the entry face_markers[r, 0] is the marker of the
+            face connecting the first and second vertex of the r-th cell.
+            Similarly, face_markers[r, 1] is the marker associated to the face connecting
+            the second and third vertex of the r-th cell. Finally, face_markers[r, 2] is
+            the marker associated to the face connecting the first and third vertex of the
+            r-th cell.
+            If not provided, the marker will be set to 0 everywhere.
+        cell_colors
+            If a dictionary is provided, it should contain key: value pairs defining the mapping
+            marker: color for cells.
+            If a string is provided instead of a dictionary, the same color will be used for all
+            cell markers.
+            If not provided, the cells will not be colored.
+        face_colors
+            If a dictionary is provided, it should contain key: value pairs defining the mapping
+            marker: color for faces.
+            If a string is provided instead of a dictionary, the same color will be used for all
+            face markers.
+            If not provided, a default black color will be used for faces.
+        face_weights
+            Line weight of each face. Input should be provided following a similar convention for
+            the face_colors argument.
+            If not provided, a unit weight will be used.
+        """
+        if cell_markers is None:
+            cell_markers = np.zeros((cells.shape[0], ), dtype=np.int64)
+        else:
+            assert cell_markers.shape[0] == cells.shape[0]
+
+        if face_markers is None:
+            face_markers = np.zeros(cells.shape, dtype=np.int64)
+        else:
+            assert face_markers.shape == cells.shape
+
+        unique_cell_markers = np.unique(cell_markers).astype(int)
+        unique_face_markers = np.unique(face_markers).astype(int)
+        cell_colors = self._process_optional_argument_on_markers(cell_colors, "none", unique_cell_markers)
+        face_colors = self._process_optional_argument_on_markers(face_colors, "black", unique_face_markers)
+        face_weights = self._process_optional_argument_on_markers(face_weights, 1, unique_face_markers)
+
+        def style_function(x: dict[str, dict[str, typing.Any]]) -> dict[str, typing.Any]:
+            if x["geometry"]["type"] == "MultiPolygon":
+                return {
+                    # Boundary properties
+                    "stroke": x["properties"]["stroke"],
+                    "color": x["properties"]["color"],
+                    "weight": x["properties"]["weight"],
+                    # Interior properties
+                    "fill": x["properties"]["fill"],
+                    "fillColor": x["properties"]["fillColor"],
+                    "fillOpacity": x["properties"]["fillOpacity"]
+                }
+            elif x["geometry"]["type"] == "MultiLineString":
+                return {
+                    "stroke": x["properties"]["stroke"],
+                    "color": x["properties"]["color"],
+                    "weight": x["properties"]["weight"]
+                }
+            else:  # pragma: no cover
+                raise ValueError("Invalid type")
+
+        json = self._convert_mesh_to_geojson(
+            vertices, cells, cell_markers, face_markers, cell_colors, face_colors, face_weights)
+        folium.GeoJson(json, style_function=style_function).add_to(geo_map)
+
+        cell_colors_where_none = np.argwhere(cell_colors == "none")
+        cell_colors_not_none = np.delete(cell_colors, cell_colors_where_none)
+        cell_colors_values = np.arange(0, np.max(unique_cell_markers) + 1)
+        cell_colors_values_not_none = np.delete(cell_colors_values, cell_colors_where_none)
+        assert cell_colors_not_none.shape == cell_colors_values_not_none.shape
+        cell_colors_in_figure = np.delete(
+            cell_colors_not_none, np.setdiff1d(cell_colors_values_not_none, unique_cell_markers))
+        cell_colors_values_in_figure = np.delete(
+            cell_colors_values_not_none, np.setdiff1d(cell_colors_values_not_none, unique_cell_markers))
+        if np.unique(cell_colors_in_figure).shape[0] > 1:
+            colorbar = ColorbarWrapper(
+                colors=cell_colors_in_figure, values=cell_colors_values_in_figure, caption="Cell markers")
+            colorbar.add_to(geo_map)
+
+        face_colors_values = np.arange(0, np.max(unique_face_markers) + 1)
+        assert face_colors.shape == face_colors_values.shape
+        face_colors_in_figure = np.delete(
+            face_colors, np.setdiff1d(face_colors_values, unique_face_markers))
+        face_colors_values_in_figure = np.delete(
+            face_colors_values, np.setdiff1d(face_colors_values, unique_face_markers))
+        if np.unique(face_colors_in_figure).shape[0] > 1:
+            colorbar = ColorbarWrapper(
+                colors=face_colors_in_figure, values=face_colors_values_in_figure, caption="Face markers")
+            colorbar.add_to(geo_map)
+
+    def _convert_mesh_to_geojson(
+        self, vertices: npt.NDArray[np.float64], cells: npt.NDArray[np.int64],
+        cell_markers: npt.NDArray[np.int64], face_markers: npt.NDArray[np.int64],
+        cell_colors: typing.Union[str, dict[int, str]], face_colors: typing.Union[str, dict[int, str]],
+        face_weights: typing.Union[int, dict[int, int]]
+    ) -> geojson.FeatureCollection:
+        """
+        Convert a mesh to a geojson FeatureCollection.
+
+        Parameters
+        ----------
+        vertices
+            Matrix containing the coordinates of the vertices.
+            The matrix should have as many rows as vertices in the mesh, and two columns.
+        cells
+            Matrix containing the connectivity of the cells.
+            The matrix should have as many rows as cells in the mesh, and three columns.
+        cell_markers
+            Vector containing a marker (i.e., an integer number) for each cell.
+            The vector should have as many entries as cells in the mesh.
+        face_markers
+            Vector containing a marker (i.e., an integer number) for each face.
+            The matrix should have the same shape of the cells argument.
+        cell_colors
+            Vector associating a cell marker to its color (i.e., a string).
+            The vector should have as many entries as the number of cell markers.
+        face_colors
+            Vector associating a face marker to its color (i.e., a string).
+            The vector should have as many entries as the number of face markers.
+        face_weights
+            Vector associating a face marker to its weight (i.e., a int).
+            The vector should have as many entries as the number of face markers.
+
+        Returns
+        -------
+        :
+            A geojson FeatureCollection representing the mesh.
+        """
+        multipolygon_coordinates = dict()
+        multipolygon_properties = dict()
+        multiline_coordinates = dict()
+        multiline_properties = dict()
+        for c in range(cells.shape[0]):
+            coordinates = [self.transformer(*vertices[cells[c, v], :]) for v in range(3)]
+            coordinates.append(coordinates[0])
+            cell_face_markers = np.unique([face_markers[c, f] for f in range(3)]).astype(np.int64)
+            if cell_face_markers.shape[0] == 1:
+                cell_key = (cell_markers[c], True)
+                cell_properties = {
+                    # Boundary properties
+                    "stroke": True,
+                    "color": face_colors[cell_face_markers[0]],
+                    "weight": int(face_weights[cell_face_markers[0]]),
+                }
+            else:
+                cell_key = (cell_markers[c], False)
+                cell_properties = {
+                    # Boundary properties
+                    "stroke": False,
+                    "color": None,
+                    "weight": None
+                }
+            if cell_colors[cell_key[0]] != "none":
+                cell_properties.update({
+                    # Interior properties
+                    "fill": True,
+                    "fillColor": cell_colors[cell_key[0]],
+                    "fillOpacity": 1
+                })
+            else:
+                cell_properties.update({
+                    # Interior properties
+                    "fill": False,
+                    "fillColor": None,
+                    "fillOpacity": None
+                })
+            # Store current cell
+            if cell_key not in multipolygon_coordinates:
+                multipolygon_coordinates[cell_key] = list()
+            multipolygon_coordinates[cell_key].append([coordinates])
+            # Store current cell properties
+            if cell_key not in multipolygon_properties:
+                multipolygon_properties[cell_key] = cell_properties
+            else:
+                assert multipolygon_properties[cell_key] == cell_properties
+            # Store faces only if there are multiple face markers in this cell,
+            # otherwise the boundary representation of the cell is sufficient.
+            if not cell_key[1]:
+                for (f, pair) in enumerate(((0, 1), (1, 2), (0, 2))):
+                    face_key = face_markers[c, f]
+                    # Store current face
+                    if face_key not in multiline_coordinates:
+                        multiline_coordinates[face_key] = list()
+                    multiline_coordinates[face_key].append([coordinates[pair[0]], coordinates[pair[1]]])
+                    # Store current face properties
+                    face_properties = {
+                        "stroke": True,
+                        "color": face_colors[face_markers[c, f]],
+                        "weight": int(face_weights[face_markers[c, f]]),
+                    }
+                    if face_key not in multiline_properties:
+                        multiline_properties[face_key] = face_properties
+                    else:
+                        assert multiline_properties[face_key] == face_properties
+
+        multipolygon_features = list()
+        for cell_key in multipolygon_coordinates.keys():
+            multipolygon = geojson.MultiPolygon(coordinates=multipolygon_coordinates[cell_key])
+            feature = geojson.Feature(
+                geometry=multipolygon,
+                properties=multipolygon_properties[cell_key]
+            )
+            multipolygon_features.append(feature)
+
+        multiline_features = list()
+        for face_key in multiline_coordinates.keys():
+            multiline = geojson.MultiLineString(coordinates=multiline_coordinates[face_key])
+            feature = geojson.Feature(
+                geometry=multiline,
+                properties=multiline_properties[face_key]
+            )
+            multiline_features.append(feature)
+
+        return geojson.FeatureCollection(multipolygon_features + multiline_features)

femlium-0.1.0/femlium/base_plotter.py

@@ -0,0 +1,64 @@
+# Copyright (C) 2021-2025 by the FEMlium authors
+#
+# This file is part of FEMlium.
+#
+# SPDX-License-Identifier: MIT
+"""Interface of a geographic plotter."""
+
+import typing
+
+import numpy as np
+import numpy.typing as npt
+import pyproj
+
+from femlium.utils import TransformerWrapper
+
+
+class BasePlotter:
+    """
+    Interface of a geographic plotter.
+
+    Parameters
+    ----------
+    transformer
+        Defines an optional transformation between coordinate reference systems (CRS) if
+        the input data use a different CRS than the output plot.
+        If not provided, the identity map is used.
+
+    Attributes
+    ----------
+    transformer
+        Wrapper to the transformer object provided as first input parameter.
+    """
+
+    def __init__(self, transformer: typing.Optional[pyproj.Transformer] = None) -> None:
+        self.transformer = TransformerWrapper(transformer)
+
+    @staticmethod
+    def _process_optional_argument_on_markers(
+        argument: typing.Any, default: typing.Any, unique_markers: npt.NDArray[typing.Any]  # noqa: ANN401
+    ) -> npt.NDArray[typing.Any]:
+        """Fill optinal arguments related to markers with default value."""
+        expected_type = type(default)
+        assert isinstance(argument, (expected_type, dict)) or argument is None
+        if isinstance(argument, dict):
+            assert all(isinstance(value, expected_type) for (_, value) in argument.items())
+
+        if isinstance(default, str):
+            dtype = np.dtype(object)  # otherwise np.dtype(str) only allows a single character
+        else:
+            dtype = np.dtype(expected_type)
+
+        assert np.min(unique_markers) >= 0
+        output = np.full(np.max(unique_markers) + 1, default, dtype=dtype)
+        for m in unique_markers:
+            if argument is None:
+                pass
+            elif isinstance(argument, expected_type):
+                output[m] = argument
+            elif isinstance(argument, dict):
+                if m in argument:
+                    output[m] = argument[m]
+            else:  # pragma: no cover
+                raise ValueError("Invalid argument provided")
+        return output