openswmm 5.3.0.dev1__tar.gz → 6.0.0a4.dev1__tar.gz

openswmm-6.0.0a4.dev1/CMakeLists.txt

@@ -0,0 +1,276 @@
+# ============================================================================
+# CMake entry point for the openswmm Python package (scikit-build-core)
+#
+# Invoked by `pip install .`, `pip install -e .`, or `python -m build`.
+# Responsibilities:
+#   1. Resolve the OpenSWMM engine (pre-built CI or from-source local dev).
+#   2. Find Python, locate Cython, and discover NumPy include paths.
+#   3. Include cmake/CythonHelpers.cmake (shared directives + helpers).
+#   4. Delegate extension builds to openswmm/CMakeLists.txt.
+# ============================================================================
+
+cmake_minimum_required(VERSION 3.24)
+
+# ============================================================================
+# Source-distribution guard: the sdist on PyPI is metadata-only and does NOT
+# carry the OpenSWMM C/C++ engine source tree.  Detect that we have neither a
+# pre-built engine prefix nor the parent project's CMakeLists.txt reachable
+# via add_subdirectory(..) and fail with a clear, actionable error rather
+# than letting vcpkg or the C compiler emit a confusing one.  Without this
+# guard, a stray VCPKG_ROOT in the user's environment causes the auto-load
+# block below to fire and vcpkg then tries to read a vcpkg.json next to the
+# unpacked sdist that does not exist.
+# ============================================================================
+if(NOT DEFINED OPENSWMM_ENGINE_INSTALL_PREFIX
+        AND NOT DEFINED ENV{OPENSWMM_ENGINE_INSTALL_PREFIX}
+        AND NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt")
+    message(FATAL_ERROR
+        "openswmm cannot be built from this source distribution: the sdist "
+        "does not bundle the OpenSWMM C/C++ engine sources, and no pre-built "
+        "engine was supplied via -DOPENSWMM_ENGINE_INSTALL_PREFIX=<path>.\n"
+        "\n"
+        "Install a pre-built wheel instead:\n"
+        "    python -m pip install openswmm\n"
+        "\n"
+        "Wheels are published for Python 3.10-3.13 on Linux x86_64 and "
+        "aarch64 (manylinux and musllinux), macOS 11+ (arm64 and x86_64), "
+        "and Windows x64. If pip fell back to this "
+        "sdist, no wheel matched your platform/interpreter -- check the "
+        "available files at https://pypi.org/project/openswmm/#files and, "
+        "if needed, switch to a supported Python version.\n"
+        "\n"
+        "Source builds are supported only from a full git checkout of the "
+        "openswmm.engine repository:\n"
+        "    git clone https://github.com/hydrocouple/openswmm.engine\n"
+        "    cd openswmm.engine/python\n"
+        "    pip install . --no-build-isolation")
+endif()
+
+# ============================================================================
+# vcpkg manifest directory: the vcpkg.json lives one directory above python/.
+# Set VCPKG_MANIFEST_DIR before project() so vcpkg's toolchain file sees it.
+# Users who install without vcpkg (e.g. system-lib builds) can ignore this.
+# ============================================================================
+if(NOT DEFINED CACHE{VCPKG_MANIFEST_DIR})
+    set(VCPKG_MANIFEST_DIR "${CMAKE_CURRENT_SOURCE_DIR}/.."
+        CACHE PATH "Directory containing vcpkg.json" FORCE)
+endif()
+
+# ============================================================================
+# Base wheel builds the Kokkos-OpenMP plugin, like every other build.
+#
+# The engine's vcpkg.json lists "gpu" in default-features (pulling Kokkos) and
+# OPENSWMM_BUILD_GPU_PLUGIN defaults ON. The wheel follows that default rather
+# than opting out of it: OpenMP acceleration of the 2D surface solver is a
+# shipped default everywhere, not something a user has to go and find.
+#
+# The `openswmm-gpu-omp` companion wheel (packages/gpu-omp/) still exists and
+# still builds the same plugin — it remains the way to add or refresh the
+# plugin against an already-installed base. Both copies are the same artifact
+# from the same source; the discovery shim in openswmm/__init__.py prefers the
+# in-wheel one, so exactly one is ever dlopen()ed (see the note there about
+# OpenMP runtimes).
+#
+# The features are still pinned explicitly rather than left to
+# default-features, so the wheel's dependency set is stated here and does not
+# silently follow a future edit of vcpkg.json.
+# ============================================================================
+if(NOT DEFINED CACHE{VCPKG_MANIFEST_NO_DEFAULT_FEATURES})
+    set(VCPKG_MANIFEST_NO_DEFAULT_FEATURES ON CACHE BOOL
+        "Wheel states its vcpkg features explicitly instead of following default-features" FORCE)
+endif()
+if(NOT DEFINED CACHE{VCPKG_MANIFEST_FEATURES})
+    # 2d  → HDF5 for the CF-1.11/UGRID output of the explicit marcher (the only
+    #       2D integrator since the D2 retirement — no SUNDIALS, no hypre).
+    # gpu → Kokkos, for the OpenMP surface-solver plugin built below.
+    set(VCPKG_MANIFEST_FEATURES "2d;gpu" CACHE STRING
+        "Explicit vcpkg features for the base wheel (2d, gpu)" FORCE)
+endif()
+
+# Auto-load vcpkg toolchain when VCPKG_ROOT is set in the environment.
+# Must be done before project() so the toolchain is processed at language
+# enable time.  Users can override by passing -DCMAKE_TOOLCHAIN_FILE=...
+# on the command line or via CMAKE_ARGS / SKBUILD_CMAKE_ARGS.
+if(NOT DEFINED CMAKE_TOOLCHAIN_FILE AND DEFINED ENV{VCPKG_ROOT})
+    set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+        CACHE PATH "vcpkg toolchain file (auto-detected from VCPKG_ROOT)")
+    message(STATUS "openswmm-python: auto-loaded vcpkg toolchain from $ENV{VCPKG_ROOT}")
+endif()
+
+project(
+    openswmm-python
+    VERSION 6.0.0
+    LANGUAGES C CXX
+)
+
+# ============================================================================
+# 1. Engine library: find_package (CI pre-built) OR add_subdirectory (local)
+# ============================================================================
+if(NOT DEFINED OPENSWMM_ENGINE_INSTALL_PREFIX
+        AND DEFINED ENV{OPENSWMM_ENGINE_INSTALL_PREFIX})
+    set(OPENSWMM_ENGINE_INSTALL_PREFIX "$ENV{OPENSWMM_ENGINE_INSTALL_PREFIX}"
+        CACHE PATH "Install prefix of a pre-built OpenSWMM engine")
+endif()
+
+if(OPENSWMM_ENGINE_INSTALL_PREFIX)
+    message(STATUS "openswmm-python: using pre-built engine from ${OPENSWMM_ENGINE_INSTALL_PREFIX}")
+    set(OPENSWMM_USE_PREBUILT_ENGINE TRUE CACHE BOOL "" FORCE)
+
+    find_package(OpenSWMMEngine CONFIG REQUIRED
+        PATHS "${OPENSWMM_ENGINE_INSTALL_PREFIX}"
+        NO_DEFAULT_PATH
+    )
+
+    # Provide openswmm:: ALIAS names consumed by all sub-CMakeLists.
+    add_library(openswmm::engine         ALIAS OpenSWMMEngine::openswmm_engine)
+    add_library(openswmm::legacy::engine ALIAS OpenSWMMEngine::openswmm_legacy_engine)
+    add_library(openswmm::legacy::output ALIAS OpenSWMMEngine::openswmm_legacy_output)
+    add_library(openswmm::common         ALIAS OpenSWMMEngine::openswmm_common)
+    add_library(openswmm::plugin_sdk     ALIAS OpenSWMMEngine::openswmm_plugin_sdk)
+
+    if(NOT DEFINED LIBRARY_VERSION)
+        set(LIBRARY_VERSION   "${PROJECT_VERSION}")
+        set(LIBRARY_SOVERSION "${PROJECT_VERSION_MAJOR}")
+    endif()
+
+else()
+    message(STATUS "openswmm-python: building engine from source")
+    set(OPENSWMM_USE_PREBUILT_ENGINE FALSE CACHE BOOL "" FORCE)
+
+    set(OPENSWMM_BUILD_TESTS             OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_UNIT_TESTS        OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_REGRESSION_TESTS  OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_BENCHMARKS        OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_PYTHON            OFF CACHE BOOL "" FORCE)
+    # Build the Kokkos-OpenMP surface plugin into the wheel. Pairs with the
+    # "gpu" vcpkg feature selected above.
+    if(NOT DEFINED CACHE{OPENSWMM_BUILD_GPU_PLUGIN})
+        set(OPENSWMM_BUILD_GPU_PLUGIN    ON CACHE BOOL "" FORCE)
+    endif()
+    # The plugin is dlopen()ed by path, so it has to land inside the import
+    # package rather than at the engine's installed-tree default of lib/ (or
+    # bin/ on Windows) — src/engine/2d/gpu/CMakeLists.txt exposes this cache
+    # variable for exactly this purpose, and packages/gpu-omp/ overrides it the
+    # same way to its own package dir.
+    #
+    # openswmm/engine specifically: it is where openswmm_engine and its bundled
+    # runtime dependencies (libomp included) already install, so the plugin sits
+    # beside the one libomp copy the wheel carries — the arrangement the macOS
+    # @rpath rewrite in the engine's plugin CMake assumes — and the factory's
+    # engine-directory search finds it with no environment variable at all.
+    if(NOT DEFINED CACHE{OPENSWMM_GPU_PLUGIN_INSTALL_DESTINATION})
+        set(OPENSWMM_GPU_PLUGIN_INSTALL_DESTINATION "openswmm/engine"
+            CACHE STRING "" FORCE)
+    endif()
+
+    # Disable WINDOWS_EXPORT_ALL_SYMBOLS: the cmake -E __create_def step
+    # cannot parse /GL (LTCG) object files on Windows CI.
+    set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS OFF)
+
+    add_subdirectory(
+        "${CMAKE_CURRENT_SOURCE_DIR}/.."
+        "${CMAKE_BINARY_DIR}/parent_build"
+        EXCLUDE_FROM_ALL
+    )
+endif()
+
+# ============================================================================
+# 2. Global settings
+# ============================================================================
+set(CMAKE_MACOSX_RPATH          ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+# Append the linked engine dylib directory to each extension's install rpath
+# automatically.  For a pre-built engine install (OPENSWMM_ENGINE_INSTALL_PREFIX)
+# this adds prefix/lib; for an editable build it adds the build-tree dir.
+# delocate/auditwheel rewrite all rpaths for wheel distribution anyway.
+if(NOT WIN32)
+    set(CMAKE_SKIP_BUILD_RPATH            FALSE)
+    set(CMAKE_BUILD_WITH_INSTALL_RPATH    FALSE)
+    set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
+endif()
+set(CMAKE_INSTALL_OPENMP_LIBRARIES  TRUE)
+include(InstallRequiredSystemLibraries)
+
+# ============================================================================
+# 2a. OpenMP — use the same custom FindOpenMP.cmake as the parent project.
+#
+# In source mode the parent's src/engine/CMakeLists.txt already includes it,
+# so the OpenMP::OpenMP_C/CXX targets exist when we reach here.
+# In pre-built mode the parent is skipped, so we must ensure the targets exist
+# ourselves before any Cython extension is linked.
+# ============================================================================
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake")
+if(NOT TARGET OpenMP::OpenMP_CXX)
+    include("${CMAKE_CURRENT_SOURCE_DIR}/../cmake/FindOpenMP.cmake")
+endif()
+
+# ============================================================================
+# 3. Python (standard CMake FindPython — scikit-build-core populates hints)
+# ============================================================================
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+message(STATUS "Python executable : ${Python_EXECUTABLE}")
+message(STATUS "Python version    : ${Python_VERSION}")
+
+# ============================================================================
+# 4. Cython driver — invoked as `python -m cython` so the cython that runs
+#    is ALWAYS the one installed in the active interpreter.  Calling a
+#    `cython` binary discovered on PATH is a footgun: the binary may shebang
+#    a different interpreter (e.g. a system / conda Python), in which case
+#    `cimport numpy` resolves to that interpreter's numpy/*.cython-3?.pxd
+#    instead of the venv's, producing ABI mismatches at compile time
+#    (e.g. _PyArray_Descr.subarray on numpy 2.x).
+# ============================================================================
+execute_process(
+    COMMAND "${Python_EXECUTABLE}" -c "import Cython, sys; sys.stdout.write(Cython.__version__)"
+    OUTPUT_VARIABLE _cython_version
+    RESULT_VARIABLE _cython_check_rc
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+if(NOT _cython_check_rc EQUAL 0)
+    message(FATAL_ERROR
+        "Cython is not importable from the active Python (${Python_EXECUTABLE}).\n"
+        "Install it with:  ${Python_EXECUTABLE} -m pip install 'cython>=3.0.12'")
+endif()
+# OPENSWMM_CYTHON_EXECUTABLE is treated as a list so add_custom_command's
+# COMMAND expansion runs `<python> -m cython ...`.
+set(OPENSWMM_CYTHON_EXECUTABLE "${Python_EXECUTABLE};-m;cython"
+    CACHE STRING "Cython driver (python -m cython) for the active interpreter" FORCE)
+message(STATUS "Cython driver     : ${Python_EXECUTABLE} -m cython (Cython ${_cython_version})")
+
+# ============================================================================
+# 5. NumPy include directory + pxd patch
+#
+# numpy.get_include() returns the C headers used by the .cxx compiler.
+# Separately, numpy ships Cython declaration files (numpy/__init__.cython-30.pxd
+# etc.) that have a known incompatibility with numpy 2.x — see
+# cmake/PatchNumpyPxd.cmake for the full story.  We materialise patched
+# copies into the build tree and prepend them to Cython's --include-dir so
+# our extensions compile against numpy 2.x without modifying the user's
+# numpy install.
+# ============================================================================
+execute_process(
+    COMMAND "${Python_EXECUTABLE}" -c "import numpy; print(numpy.get_include())"
+    OUTPUT_VARIABLE NUMPY_INCLUDE_DIR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE _numpy_rc
+)
+if(NOT _numpy_rc EQUAL 0)
+    message(FATAL_ERROR "Could not determine NumPy include directory")
+endif()
+message(STATUS "NumPy include dir : ${NUMPY_INCLUDE_DIR}")
+set(NUMPY_INCLUDE_DIR "${NUMPY_INCLUDE_DIR}" CACHE PATH "" FORCE)
+
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/PatchNumpyPxd.cmake")
+openswmm_patch_numpy_pxd()
+set(OPENSWMM_NUMPY_PATCHED_INCLUDE_DIR
+    "${OPENSWMM_NUMPY_PATCHED_INCLUDE_DIR}" CACHE PATH "" FORCE)
+
+# ============================================================================
+# 6. Cython helper functions (shared directives + add_cython_extension)
+# ============================================================================
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/CythonHelpers.cmake")
+
+# ============================================================================
+# 7. Cython extensions
+# ============================================================================
+add_subdirectory(openswmm)

openswmm-6.0.0a4.dev1/CMakePresets.json

@@ -0,0 +1,163 @@
+{
+    "version": 3,
+    "configurePresets": [
+        {
+            "name": "base",
+            "hidden": true,
+            "generator": "Ninja",
+            "toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+            "cacheVariables": {
+                "CMAKE_EXPORT_COMPILE_COMMANDS": "YES"
+            }
+        },
+        {
+            "name": "base-debug",
+            "hidden": true,
+            "inherits": "base",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
+        },
+        {
+            "name": "Windows",
+            "inherits": "base",
+            "description": "Windows release build",
+            "generator": "Visual Studio 17 2022",
+            "toolset": {
+                "value": "v143",
+                "strategy": "external"
+            },
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_C_FLAGS": "/O2 /GL /fp:precise /W4",
+                "CMAKE_CXX_FLAGS": "/O2 /GL /fp:precise /W4",
+                "CMAKE_EXE_LINKER_FLAGS": "/LTCG /OPT:REF /OPT:ICF",
+                "CMAKE_SHARED_LINKER_FLAGS": "/LTCG /OPT:REF /OPT:ICF",
+                "CMAKE_MODULE_LINKER_FLAGS": "/LTCG /OPT:REF /OPT:ICF",
+                "CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS": "OFF"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Windows"
+            }
+        },
+        {
+            "name": "Windows-debug",
+            "inherits": "base-debug",
+            "description": "Windows debug build",
+            "generator": "Visual Studio 17 2022",
+            "toolset": {
+                "value": "v143",
+                "strategy": "external"
+            },
+            "cacheVariables": {
+                "CMAKE_C_FLAGS": "/Zi /Od /DDEBUG /W4 /fp:precise",
+                "CMAKE_CXX_FLAGS": "/Zi /Od /DDEBUG /W4 /fp:precise",
+                "CMAKE_EXE_LINKER_FLAGS": "/DEBUG"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Windows"
+            }
+        },
+        {
+            "name": "Linux",
+            "inherits": "base",
+            "description": "Linux release build",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_C_FLAGS": "-O2 -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -fexcess-precision=standard -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O2 -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-Wl,--gc-sections",
+                "CMAKE_SHARED_LINKER_FLAGS": "-Wl,--gc-sections",
+                "CMAKE_MODULE_LINKER_FLAGS": ""
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Linux"
+            }
+        },
+        {
+            "name": "Linux-debug",
+            "inherits": "base-debug",
+            "description": "Linux debug build",
+            "cacheVariables": {
+                "CMAKE_C_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -fexcess-precision=standard -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-g"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Linux"
+            }
+        },
+        {
+            "name": "Darwin",
+            "inherits": "base",
+            "description": "macOS release build",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_C_FLAGS": "-O2 -flto -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O2 -flto -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-flto",
+                "CMAKE_SHARED_LINKER_FLAGS": "-flto -twolevel_namespace",
+                "CMAKE_MODULE_LINKER_FLAGS": "-flto -undefined dynamic_lookup"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Darwin"
+            }
+        },
+        {
+            "name": "Darwin-debug",
+            "inherits": "base-debug",
+            "description": "macOS debug build",
+            "cacheVariables": {
+                "CMAKE_C_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-g",
+                "CMAKE_SHARED_LINKER_FLAGS": "-twolevel_namespace",
+                "CMAKE_MODULE_LINKER_FLAGS": "-undefined dynamic_lookup"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Darwin"
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "Windows",
+            "configurePreset": "Windows",
+            "targets": ["package"]
+        },
+        {
+            "name": "Windows-debug",
+            "configurePreset": "Windows-debug"
+        },
+        {
+            "name": "Linux",
+            "configurePreset": "Linux",
+            "targets": ["package"]
+        },
+        {
+            "name": "Linux-debug",
+            "configurePreset": "Linux-debug"
+        },
+        {
+            "name": "Darwin",
+            "configurePreset": "Darwin",
+            "targets": ["package"]
+        },
+        {
+            "name": "Darwin-debug",
+            "configurePreset": "Darwin-debug"
+        }
+    ]
+}

openswmm-6.0.0a4.dev1/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 HydroCouple Developers
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.