pytetwild 0.2.0__cp312-abi3-macosx_15_0_x86_64.whl

pytetwild/PyfTetWildWrapper.pyi

@@ -0,0 +1,29 @@
+import numpy as np
+from numpy.typing import NDArray
+
+def tetrahedralize_mesh(
+    vertices: NDArray[np.float64],
+    faces: NDArray[np.uint32],
+    optimize: bool,
+    skip_simplify: bool,
+    edge_length_r: float,
+    edge_length_abs: float,
+    epsilon: float,
+    stop_energy: float,
+    coarsen: bool,
+    num_threads: int,
+    num_opt_iter: int,
+    loglevel: int,
+    quiet: bool,
+    vtk_ordering: bool,
+) -> tuple[NDArray[np.float64], NDArray[np.int32]]: ...
+def tetrahedralize_csg(
+    csg_file: str,
+    epsilon: float,
+    edge_length_r: float,
+    stop_energy: float,
+    coarsen: bool,
+    num_threads: int,
+    log_level: int,
+    vtk_ordering: bool,
+) -> tuple[NDArray[np.float64], NDArray[np.int32], NDArray[np.int32]]: ...

pytetwild/__init__.py

@@ -0,0 +1,4 @@
+"""Wrapper for fTetWild."""
+
+from ._version import __version__  # noqa: F401
+from .pytetwild import tetrahedralize, tetrahedralize_pv, tetrahedralize_csg  # noqa: F401

pytetwild/_version.py

@@ -0,0 +1,5 @@
+"""Contains the pytetwild version."""
+
+from importlib import metadata
+
+__version__ = metadata.version("pytetwild")

pytetwild/py.typed

@@ -0,0 +1 @@
+partial

pytetwild/pytetwild.py

@@ -0,0 +1,365 @@
+"""Wrapper for fTetWild."""
+
+import warnings
+import numpy as np
+from pytetwild import PyfTetWildWrapper
+from typing import TYPE_CHECKING
+from numpy.typing import NDArray
+
+if TYPE_CHECKING:
+    import pyvista as pv
+
+VTK_UNSIGNED_CHAR = 3
+VTK_TETRA = 10
+VTK_QUADRATIC_TETRA = 24
+
+
+def _check_edge_length(edge_length_fac: float) -> None:
+    """Check edge length.
+
+    Parameters
+    ----------
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagonal. The
+        default ideal edge length is bb/20 (bounding box divided by 20).
+
+    """
+    if edge_length_fac > 1.0 or edge_length_fac < 0.0 + 1e-16:
+        raise ValueError("Edge length factor must be between 1e-16 and 1.0")
+
+
+def _ugrid_from_regular_cells(
+    points: NDArray[np.float32] | NDArray[np.float64],
+    cells: NDArray[np.int32],
+) -> "pv.UnstructuredGrid":
+    """
+    Create an UnstructuredGrid from points and fixed-size cells.
+
+    Parameters
+    ----------
+    points : np.ndarray[np.float64]
+        Point coordinates.
+    cells : np.ndarray[np.int32]
+        Cell connectivity without padding. Cell type inferred from shape.
+
+    Returns
+    -------
+    pyvista.UnstructuredGrid
+        Unstructured grid.
+
+    """
+    try:
+        import pyvista.core as pv
+    except:
+        raise ModuleNotFoundError(
+            "Install PyVista to use this feature with:\n\npip install pytetwild[all]"
+        )
+
+    from vtkmodules.vtkCommonCore import vtkTypeInt32Array
+    from vtkmodules.util.numpy_support import numpy_to_vtk
+    from vtkmodules.vtkCommonDataModel import vtkCellArray
+
+    if cells.ndim != 2:
+        raise ValueError("cells must be 2D")
+
+    grid = pv.UnstructuredGrid()
+    grid.points = points
+
+    n_cells, n_nodes_per_cell = cells.shape
+    vtk_dtype = vtkTypeInt32Array().GetDataType()
+    offsets = np.arange(0, n_cells * n_nodes_per_cell + 1, n_nodes_per_cell, dtype=np.int32)
+    offsets_vtk = numpy_to_vtk(offsets, deep=False, array_type=vtk_dtype)
+    conn_vtk = numpy_to_vtk(cells.ravel(), deep=False, array_type=vtk_dtype)
+
+    cell_array = vtkCellArray()
+    cell_array.SetData(offsets_vtk, conn_vtk)
+
+    if n_nodes_per_cell == 4:
+        cell_type = VTK_TETRA
+    elif n_nodes_per_cell == 10:
+        cell_type = VTK_QUADRATIC_TETRA
+    else:
+        raise ValueError(f"Unsupported number of nodes per cells {n_nodes_per_cell}")
+
+    celltypes = numpy_to_vtk(
+        np.full(n_cells, cell_type, dtype=np.uint8), deep=False, array_type=VTK_UNSIGNED_CHAR
+    )
+    grid.SetCells(celltypes, cell_array)
+    return grid
+
+
+def tetrahedralize_pv(
+    mesh: "pv.PolyData",
+    edge_length_fac: float = 0.05,
+    edge_length_abs: float | None = None,
+    optimize: bool = True,
+    simplify: bool = True,
+    epsilon: float = 1e-3,
+    stop_energy: float = 10.0,
+    coarsen: bool = False,
+    num_threads: int = 0,
+    num_opt_iter: int = 80,
+    loglevel: int = 3,
+    quiet: bool = True,
+) -> "pv.UnstructuredGrid":
+    """
+    Convert a PyVista surface mesh to a PyVista unstructured grid.
+
+    Parameters
+    ----------
+    mesh : pv.PolyData
+        The input surface mesh. Should be composed of all triangles.
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagonal. The
+        default ideal edge length is ``bb/20`` (bounding box divided by
+        20). Ignored when ``edge_length_abs`` is input.
+    edge_length_abs : float, optional
+        Absolute ideal edge length. When input ``edge_length_fac`` is ignored.
+    optimize : bool, default: True
+        Improve the minimum scaled Jacobean for each cell. This leads to higher
+        cell quality at the expense of computation time. Optimization level is
+        dependent on ``stop_energy`` and ``num_opt_iter``.
+    simplify : bool, default: True
+        Simplfiy the input mesh surface before tetrahedralization.
+    epsilon : float, default 1e-3
+        Envelop size, specifying the maximum distance of the output surface
+        from the input surface, relative to the bounding box size.
+    stop_energy : float, default: 10.0
+        The mesh optimization stops when the conformal AMIPS energy reaches
+        ``stop_energy``.
+    coarsen : bool, default: False
+        Coarsen the output as much as possible, while maintaining the mesh
+        quality.
+    num_threads : int, default: 0
+        Set number of threads used. 0 (default) uses all available cores.
+    num_opt_iter : int, default: 80
+        Maximum number of optimization iterations if ``optimize=True``.
+    loglevel : int, default: 6
+        Set log level (0 = most verbose, 6 = minimal output).
+    quiet : bool, default: False
+        Disable all output. Overrides ``loglevel``.
+
+    Returns
+    -------
+    pv.UnstructuredGrid
+        The converted unstructured grid containing only tetrahedra.
+
+    Examples
+    --------
+    >>> import pyvista as pv
+    >>> import pytetwild
+    >>> surface_mesh = pv.Sphere()
+    >>> tetrahedral_mesh = pytetwild.tetrahedralize_pv(surface_mesh)
+    >>> tetrahedral_mesh
+    UnstructuredGrid (0x7ff568593d00)
+      N Cells:    7247
+      N Points:   1658
+      X Bounds:   -4.993e-01, 4.993e-01
+      Y Bounds:   -4.965e-01, 4.965e-01
+      Z Bounds:   -5.000e-01, 4.999e-01
+      N Arrays:   0
+
+    """
+    try:
+        import pyvista.core as pv
+    except:
+        raise ModuleNotFoundError(
+            "Install PyVista to use this feature with:\n\npip install pytetwild[all]"
+        )
+
+    if not isinstance(mesh, pv.PolyData):
+        raise TypeError(f"`mesh` must be a pyvista.PolyData, got {type(mesh)}")
+    if not mesh.is_all_triangles:
+        warnings.warn(
+            "Input mesh is not all triangles. Either call `.triangulate()`"
+            " beforehand to suppress this warning or use an all triangle mesh."
+        )
+        mesh = mesh.triangulate()
+    _check_edge_length(edge_length_fac)
+
+    if edge_length_abs is None:
+        edge_length_abs = 0.0
+
+    vertices = mesh.points.astype(np.float64, copy=False)
+    faces = mesh._connectivity_array.reshape(-1, 3)
+    if faces.dtype == np.int32:
+        # we can cheat here and just treat it as unsigned 32 (assuming no negative indices)
+        faces_unsigned = faces.view(np.uint32)
+    else:
+        faces_unsigned = faces.astype(np.uint32, copy=False)
+
+    skip_simplify = not simplify
+    vtk_ordering = True
+    tmesh_v, tmesh_c = PyfTetWildWrapper.tetrahedralize_mesh(
+        vertices,
+        faces_unsigned,
+        optimize,
+        skip_simplify,
+        edge_length_fac,
+        edge_length_abs,
+        epsilon,
+        stop_energy,
+        coarsen,
+        num_threads,
+        num_opt_iter,
+        loglevel,
+        quiet,
+        vtk_ordering,
+    )
+    return _ugrid_from_regular_cells(tmesh_v, tmesh_c)
+
+
+def tetrahedralize(
+    vertices: NDArray[np.float32] | NDArray[np.float64],
+    faces: NDArray[np.int32],
+    edge_length_fac: float = 0.05,
+    edge_length_abs: float | None = None,
+    optimize: bool = True,
+    simplify: bool = True,
+    epsilon: float = 1e-3,
+    stop_energy: float = 10.0,
+    coarsen: bool = False,
+    num_threads: int = 0,
+    num_opt_iter: int = 80,
+    loglevel: int = 3,
+    quiet: bool = True,
+    vtk_ordering: bool = False,
+) -> tuple[NDArray[np.float64], NDArray[np.int32]]:
+    """
+    Convert mesh vertices and faces to a tetrahedral mesh.
+
+    Parameters
+    ----------
+    vertices : np.ndarray[np.float32] | np.ndarray[np.float64]
+        The vertices of the mesh.
+    faces : np.ndarray[np.int32]
+        The faces of the mesh.
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagonal. The
+        default ideal edge length is bb/20 (bounding box divided by
+        20). Ignored when ``edge_length_abs`` is input.
+    edge_length_abs : float, optional
+        Absolute ideal edge length. When input ``edge_length_fac`` is ignored.
+    optimize : bool
+        Improve the minimum scaled Jacobean for each cell. This leads to higher
+        cell quality at the expense of computation time.
+    simplify : bool, default: True
+        Simplfiy the input mesh surface before tetrahedralization.
+    epsilon : float, default 1e-3
+        Envelop size, specifying the maximum distance of the output surface
+        from the input surface, relative to the bounding box size.
+    stop_energy : float, default: 10.0
+        The mesh optimization stops when the conformal AMIPS energy reaches
+        ``stop_energy``.
+    coarsen : bool, default: False
+        Coarsen the output as much as possible, while maintaining the mesh
+        quality.
+    num_threads : int, default: 0
+        Set number of threads used. 0 (default) uses all available cores.
+    num_opt_iter : int, default: 80
+        Maximum number of optimization iterations if ``optimize=True``.
+    loglevel : int, default: 6
+        Set log level (0 = most verbose, 6 = minimal output).
+    quiet : bool, default: False
+        Disable all output. Overrides ``loglevel``.
+    vtk_ordering : bool, default: False
+        Reorder the tetrahedral cell indices to match VTK's ordering.
+
+    Returns
+    -------
+    Tuple[np.ndarray, np.ndarray]
+        A tuple containing the vertices and tetrahedra of the tetrahedral mesh.
+    """
+    _check_edge_length(edge_length_fac)
+    if not isinstance(vertices, np.ndarray):
+        raise TypeError("`vertices` must be a numpy array")
+    if not isinstance(faces, np.ndarray):
+        raise TypeError("`faces` must be a numpy array")
+    vertices = vertices.astype(np.float64, copy=False)
+    if faces.dtype == np.int32:
+        # we can cheat here and just treat it as unsigned 32 (assuming no negative indices)
+        faces_unsigned = faces.view(np.uint32)
+    else:
+        faces_unsigned = faces.astype(np.uint32, copy=False)
+
+    if edge_length_abs is None:
+        edge_length_abs = 0.0
+
+    skip_simplify = not simplify
+    return PyfTetWildWrapper.tetrahedralize_mesh(
+        vertices,
+        faces_unsigned,
+        optimize,
+        skip_simplify,
+        edge_length_fac,
+        edge_length_abs,
+        epsilon,
+        stop_energy,
+        coarsen,
+        num_threads,
+        num_opt_iter,
+        loglevel,
+        quiet,
+        vtk_ordering,
+    )
+
+
+def tetrahedralize_csg(
+    csg_file: str,
+    epsilon: float = 1e-3,
+    edge_length_r: float = 0.05,
+    stop_energy: float = 10.0,
+    coarsen: bool = True,
+    num_threads: int = 0,
+    loglevel: int = 3,
+) -> "pv.UnstructuredGrid":
+    """
+    Generate a tetrahedral mesh based on a the CSG tree specified in the csf_file.
+
+    Parameters
+    ----------
+    csg_file : str
+        Path to the input json file.
+    epsilon : float, default 1e-3
+        Envelop size, specifying the maximum distance of the output surface
+        from the input surface, relative to the bounding box size.
+    edge_length_r : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagonal. The
+        default ideal edge length is bb/20 (bounding box divided by 20).
+    stop_energy : float, default: 10.0
+        The mesh optimization stops when the  conformal AMIPS energy reaches 'stop_energy'.
+    coarsen : bool, default: true
+        Coarsen the output as much as possible, while maintaining the mesh quality.
+    num_threads : int, default: 0
+        Set number of threads used (0 means all available cores).
+    loglevel : int, default: 6
+        Set log level (0 = most verbose, 6 = minimal output).
+
+    Returns
+    -------
+    pv.UnstructuredGrid
+        The converted unstructured grid containing only tetrahedra, with a cell
+        attribute 'marker' indicating which of the input surfaces the cell
+        belongs to.
+    """
+    try:
+        pass
+    except:
+        raise ModuleNotFoundError(
+            "Install PyVista to use this feature with:\n\npip install pytetwild[all]"
+        )
+    vtk_ordering = True
+    tmesh_v, tmesh_c, tmesh_marker = PyfTetWildWrapper.tetrahedralize_csg(
+        csg_file,
+        epsilon,
+        edge_length_r,
+        stop_energy,
+        coarsen,
+        num_threads,
+        loglevel,
+        vtk_ordering,
+    )
+
+    ugrid = _ugrid_from_regular_cells(tmesh_v, tmesh_c).clean()
+    ugrid["marker"] = tmesh_marker
+    return ugrid

pytetwild-0.2.0.dist-info/METADATA

@@ -0,0 +1,180 @@
+Metadata-Version: 2.2
+Name: pytetwild
+Version: 0.2.0
+Summary: Python wrapper of fTetWild
+Author-Email: Alex Kaszynski <akascap@gmail.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS
+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
+Requires-Python: <3.15,>=3.10
+Requires-Dist: numpy
+Provides-Extra: all
+Requires-Dist: pyvista; extra == "all"
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pyvista; extra == "tests"
+Requires-Dist: scipy; extra == "tests"
+Requires-Dist: meshio; extra == "tests"
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Description-Content-Type: text/x-rst
+
+pytetwild
+#########
+
+|pypi| |MPL|
+
+.. |pypi| image:: https://img.shields.io/pypi/v/pytetwild.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/pytetwild/
+
+.. |MPL| image:: https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg
+   :target: https://opensource.org/license/mpl-2-0
+
+``pytetwild`` is a Python library for mesh tetrahedralization. It is a
+Python wrapper around the efficient C++ library for tetrahedral meshing provided by
+`fTetWild <https://github.com/wildmeshing/fTetWild>`_.
+
+
+Installation
+************
+
+We have pre-built wheels for Python 3.10 - Python 3.14 for Windows, Linux, and macOS.
+
+The recommended way to install ``pytetwild`` is via PyPI:
+
+.. code:: sh
+
+   pip install pytetwild[all]
+
+This installs ``pyvista`` by default, which you can use to tetrahedralize
+sufrace meshes from PyVista. Alternatively you can just install with ``pip
+install pytetwild`` for a lighter install.
+
+You can also clone the repository and install it from source, but since there's
+C++ involved, the build is a bit more complicated. See ``CONTRIBUTING.md`` for
+more details.
+
+
+Usage
+*****
+
+To tetrahedralize a surface mesh from `PyVista <https://docs.pyvista.org>`_,
+you'll need to first install ``pyvista`` as it's not a dependency and then run:
+
+.. code:: py
+
+   import pyvista as pv
+   import pytetwild
+
+   # Load or create a PyVista PolyData surface mesh
+   # Here, we'll create a simple sphere mesh as an example
+   surface_mesh = pv.Icosphere(nsub=2)
+
+   # Convert the surface mesh to a tetrahedral mesh. For this example let's
+   # use a coarse mesh
+   tetrahedral_mesh = pytetwild.tetrahedralize_pv(surface_mesh, edge_length_fac=1)
+
+   # Visualize the tetrahedral mesh in an "exploded" view
+   tetrahedral_mesh.explode(0.5).plot(
+       show_edges=True, zoom=1.6, ssao=True, anti_aliasing="ssaa"
+   )
+
+
+.. image:: https://github.com/pyvista/pytetwild/raw/main/exploded-sphere.png
+
+You can also work with raw arrays. Here's a simple cube that we turn into tetrahedra.
+
+.. code:: py
+
+   import numpy as np
+   import pytetwild
+
+   # Define vertices of the cube
+   vertices = np.array([
+       [0, 0, 0],  # Vertex 0
+       [1, 0, 0],  # Vertex 1
+       [1, 1, 0],  # Vertex 2
+       [0, 1, 0],  # Vertex 3
+       [0, 0, 1],  # Vertex 4
+       [1, 0, 1],  # Vertex 5
+       [1, 1, 1],  # Vertex 6
+       [0, 1, 1]   # Vertex 7
+   ])
+
+   # Define faces using vertex indices
+   # Each face is a rectangle (also accepts triangles)
+   faces = np.array([
+       [0, 1, 2, 3],  # Front face
+       [1, 5, 6, 2],  # Right face
+       [5, 4, 7, 6],  # Back face
+       [4, 0, 3, 7],  # Left face
+       [4, 5, 1, 0],  # Bottom face
+       [3, 2, 6, 7]   # Top face
+   ])
+   v_out, tetra = pytetwild.tetrahedralize(vertices, faces, optimize=False)
+
+
+Usage - Options
+---------------
+We've surfaced a several parameters to each of our interfaces
+``tetrahedralize`` and ``tetrahedralize_pv``:
+
+.. code::
+
+    Parameters
+    ----------
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagonal. The
+        default ideal edge length is ``bb/20`` (bounding box divided by
+        20). Ignored when ``edge_length_abs`` is input.
+    edge_length_abs : float, optional
+        Absolute ideal edge length. When input ``edge_length_fac`` is ignored.
+    optimize : bool, default: True
+        Improve the minimum scaled Jacobean for each cell. This leads to higher
+        cell quality at the expense of computation time. Optimization level is
+        dependent on ``stop_energy`` and ``num_opt_iter``.
+    simplify : bool, default: True
+        Simplfiy the input mesh surface before tetrahedralization.
+    epsilon : float, default 1e-3
+        Envelop size, specifying the maximum distance of the output surface
+        from the input surface, relative to the bounding box size.
+    stop_energy : float, default: 10.0
+        The mesh optimization stops when the conformal AMIPS energy reaches
+        ``stop_energy``.
+    coarsen : bool, default: False
+        Coarsen the output as much as possible, while maintaining the mesh
+        quality.
+    num_threads : int, default: 0
+        Set number of threads used. 0 (default) uses all available cores.
+    num_opt_iter : int, default: 80
+        Maximum number of optimization iterations if ``optimize=True``.
+    loglevel : int, default: 6
+        Set log level (0 = most verbose, 6 = minimal output).
+    quiet : bool, default: False
+        Disable all output. Overrides ``loglevel``.
+
+
+
+License and Acknowledgments
+***************************
+
+This project relies on ``fTetWild`` and credit goes to the original authors for
+their efficient C++ library for tetrahedral meshing. That work is licensed
+under the Mozilla Public License v2.0.
+
+The work in this repository is also licensed under the Mozilla Public License v2.0.
+
+Support
+*******
+
+If you are having issues, please feel free to raise an `Issue
+<https://github.com/pyvista/pytetwild/issues>`_.

pytetwild-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pytetwild-0.2.0.dist-info/RECORD,,
+pytetwild-0.2.0.dist-info/WHEEL,sha256=ey3_uyy1pWvl1IpjcRt2cRv6ml15QL5BcDDgLyUtWkg,141
+pytetwild-0.2.0.dist-info/METADATA,sha256=W2TWaKZlnSapb1l0vwV4nvbPQNiaPd76VdoaEm1hdFI,6131
+pytetwild-0.2.0.dist-info/licenses/LICENSE,sha256=S4nUUYvRNatO4VSnvOciJGtXqYw9fvwaCUCYmBYMK9E,16724
+pytetwild/PyfTetWildWrapper.abi3.so,sha256=l4hck_CwqjXHUOQ02kzTpHz4-EmvkPspGzdo-ISx8RA,6779616
+pytetwild/_version.py,sha256=qDxTMPS7diuO_YwLR1aF11vCH9c4gjMocv2O7QB-wFk,115
+pytetwild/__init__.py,sha256=uIyInmpybLC_OCJyr2yYVcdp0WxweLudksNqKvOijpY,168
+pytetwild/pytetwild.py,sha256=vnrEwAXcn31M5FSedtog4h1_VHj3C-oXLdZY-Xt-rN4,12236
+pytetwild/py.typed,sha256=mDShSrm8qg9qjacQc2F-rI8ATllqP6EdgHuEYxuCXZ0,7
+pytetwild/PyfTetWildWrapper.pyi,sha256=774Qi5gUvNBF8oMEliEA4304LeUC9JKOioHM-HVSpyQ,740
+pytetwild/.dylibs/libgmp.10.dylib,sha256=Y0mnXhEhmmZ7tf0TzjEQPnFZQJ7vfVGBgQJfVeSak_8,440864

pytetwild-0.2.0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.11.6
+Root-Is-Purelib: false
+Tag: cp312-abi3-macosx_15_0_x86_64
+Generator: delocate 0.13.0
+

pytetwild-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.