meshkernel 2.0.1__tar.gz → 2.0.2__tar.gz

{meshkernel-2.0.1 → meshkernel-2.0.2}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: meshkernel
-Version: 2.0.1
+Version: 2.0.2
 Summary: `meshkernel` is a library which can be used to manipulate meshes.
 Home-page: https://github.com/Deltares/MeshKernelPy
-Author: Julian Hofer, Prisca van der Sluis
-Author-email: julian.hofer@deltares.nl, prisca.vandersluis@deltares.nl
+Author: Julian Hofer, Prisca van der Sluis, Luca Carniato
+Author-email: julian.hofer@deltares.nl, prisca.vandersluis@deltares.nl, luca.carniato@deltares.nl
 License: MIT
 Platform: Windows
 Platform: Linux
@@ -83,3 +83,26 @@ Then add a compiled `MeshKernelApi.dll` into your `src` folder.
 
 Also make sure that your editor is configured to format the code with [`black`](https://black.readthedocs.io/en/stable/) and [`isort`](https://pycqa.github.io/isort/).
 When modifying `Jupyter` notebooks, the [`jupyterlab-code-formatter`](https://jupyterlab-code-formatter.readthedocs.io/en/latest/installation.html) can be used.
+
+# Building linux wheels
+
+To deploy Linux wheels to PyPI, we provide a Docker image that is based on manylinux2014_x86_64. 
+This image includes cmake and boost, which are necessary for compiling the native MeshKernel library (written in C++). 
+To build the Docker image, please follow these steps:
+
+```powershell
+cd scripts
+docker build --progress=plain ./scripts -t build_linux_library
+cd ..
+```
+
+Once the Docker image has been built, build the linux wheels using the following command:
+
+```powershell
+docker run -v %cd%:/root --rm build_linux_library 
+```
+
+The deployable linux wheels will be located in dist/wheelhouse
+
+
+

{meshkernel-2.0.1 → meshkernel-2.0.2}/README.md

@@ -65,3 +65,24 @@ Then add a compiled `MeshKernelApi.dll` into your `src` folder.
 
 Also make sure that your editor is configured to format the code with [`black`](https://black.readthedocs.io/en/stable/) and [`isort`](https://pycqa.github.io/isort/).
 When modifying `Jupyter` notebooks, the [`jupyterlab-code-formatter`](https://jupyterlab-code-formatter.readthedocs.io/en/latest/installation.html) can be used.
+
+# Building linux wheels
+
+To deploy Linux wheels to PyPI, we provide a Docker image that is based on manylinux2014_x86_64. 
+This image includes cmake and boost, which are necessary for compiling the native MeshKernel library (written in C++). 
+To build the Docker image, please follow these steps:
+
+```powershell
+cd scripts
+docker build --progress=plain ./scripts -t build_linux_library
+cd ..
+```
+
+Once the Docker image has been built, build the linux wheels using the following command:
+
+```powershell
+docker run -v %cd%:/root --rm build_linux_library 
+```
+
+The deployable linux wheels will be located in dist/wheelhouse
+

{meshkernel-2.0.1 → meshkernel-2.0.2}/meshkernel/meshkernel.py

@@ -1,4 +1,5 @@
 import logging
+import os
 import platform
 from ctypes import CDLL, byref, c_char_p, c_double, c_int, c_size_t
 from enum import IntEnum, unique
@@ -66,13 +67,15 @@ class MeshKernel:
 
         # Determine OS
         system = platform.system()
+
+        file_path = Path(__file__).parent
         if system == "Windows":
-            lib_path = Path(__file__).parent / "MeshKernelApi.dll"
+            lib_path = os.path.join(file_path, "MeshKernelApi.dll")
         elif system == "Linux":
-            lib_path = Path(__file__).parent / "libMeshKernelApi.so"
-        elif system == "Darwin":
-            lib_path = Path(__file__).parent / "libMeshKernelApi.dylib"
+            lib_path = os.path.join(file_path, "libMeshKernelApi.so")
         else:
+            if not str:
+                system = "Unknown OS"
             raise OSError(f"Unsupported operating system: {system}")
 
         self.lib = CDLL(str(lib_path))
@@ -1421,8 +1424,8 @@ class MeshKernel:
         self._execute_function(
             self.lib.mkernel_curvilinear_make_uniform,
             self._meshkernelid,
-            c_make_grid_parameters,
-            c_geometry_list,
+            byref(c_make_grid_parameters),
+            byref(c_geometry_list),
         )
 
     def curvilinear_refine(
@@ -1504,7 +1507,7 @@ class MeshKernel:
         self._execute_function(
             self.lib.mkernel_curvilinear_compute_transfinite_from_polygon,
             self._meshkernelid,
-            c_geometry_list,
+            byref(c_geometry_list),
             c_int(first_node),
             c_int(second_node),
             c_int(third_node),
@@ -1532,7 +1535,7 @@ class MeshKernel:
         self._execute_function(
             self.lib.mkernel_curvilinear_compute_transfinite_from_polygon,
             self._meshkernelid,
-            c_geometry_list,
+            byref(c_geometry_list),
             c_int(first_node),
             c_int(second_node),
             c_int(third_node),
@@ -1556,7 +1559,7 @@ class MeshKernel:
         self._execute_function(
             self.lib.mkernel_curvilinear_initialize_orthogonalize,
             self._meshkernelid,
-            c_orthogonalization_parameters,
+            byref(c_orthogonalization_parameters),
         )
 
     def curvilinear_set_block_orthogonalize(

meshkernel-2.0.2/meshkernel/version.py

@@ -0,0 +1 @@
+__version__ = "2.0.2"

{meshkernel-2.0.1 → meshkernel-2.0.2}/meshkernel.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: meshkernel
-Version: 2.0.1
+Version: 2.0.2
 Summary: `meshkernel` is a library which can be used to manipulate meshes.
 Home-page: https://github.com/Deltares/MeshKernelPy
-Author: Julian Hofer, Prisca van der Sluis
-Author-email: julian.hofer@deltares.nl, prisca.vandersluis@deltares.nl
+Author: Julian Hofer, Prisca van der Sluis, Luca Carniato
+Author-email: julian.hofer@deltares.nl, prisca.vandersluis@deltares.nl, luca.carniato@deltares.nl
 License: MIT
 Platform: Windows
 Platform: Linux
@@ -83,3 +83,26 @@ Then add a compiled `MeshKernelApi.dll` into your `src` folder.
 
 Also make sure that your editor is configured to format the code with [`black`](https://black.readthedocs.io/en/stable/) and [`isort`](https://pycqa.github.io/isort/).
 When modifying `Jupyter` notebooks, the [`jupyterlab-code-formatter`](https://jupyterlab-code-formatter.readthedocs.io/en/latest/installation.html) can be used.
+
+# Building linux wheels
+
+To deploy Linux wheels to PyPI, we provide a Docker image that is based on manylinux2014_x86_64. 
+This image includes cmake and boost, which are necessary for compiling the native MeshKernel library (written in C++). 
+To build the Docker image, please follow these steps:
+
+```powershell
+cd scripts
+docker build --progress=plain ./scripts -t build_linux_library
+cd ..
+```
+
+Once the Docker image has been built, build the linux wheels using the following command:
+
+```powershell
+docker run -v %cd%:/root --rm build_linux_library 
+```
+
+The deployable linux wheels will be located in dist/wheelhouse
+
+
+

{meshkernel-2.0.1 → meshkernel-2.0.2}/meshkernel.egg-info/top_level.txt

@@ -1 +1,2 @@
+MeshKernel
 meshkernel

meshkernel-2.0.2/setup.py

@@ -0,0 +1,228 @@
+import codecs
+import os
+import pathlib
+import platform
+import shutil
+
+from setuptools import Extension, find_packages, setup
+from setuptools.command.build_ext import build_ext as build_ext_orig
+
+author_dict = {
+    "Julian Hofer": "julian.hofer@deltares.nl",
+    "Prisca van der Sluis": "prisca.vandersluis@deltares.nl",
+    "Luca Carniato": "luca.carniato@deltares.nl",
+}
+__author__ = ", ".join(author_dict.keys())
+__author_email__ = ", ".join(s for _, s in author_dict.items())
+
+
+def read(rel_path: str) -> str:
+    """Used to read a text file
+
+    Args:
+        rel_path (str): Relative path to the file
+
+    Returns:
+        str: File content
+    """
+    here = os.path.abspath(os.path.dirname(__file__))
+    with codecs.open(os.path.join(here, rel_path), "r") as fp:
+        return fp.read()
+
+
+def get_version(rel_path: str) -> str:
+    """Get the version string
+
+    Args:
+        rel_path (str): Relative path to the file
+
+    Raises:
+        RuntimeError: Raised if the version string could not be found
+
+    Returns:
+        str: The version string
+    """
+    for line in read(rel_path).splitlines():
+        if line.startswith("__version__"):
+            delim = '"' if '"' in line else "'"
+            return line.split(delim)[1]
+
+    raise RuntimeError("Unable to find version string.")
+
+
+def get_library_name() -> str:
+    """Get the filename of the MeshKernel library
+
+    Raises:
+        OSError: If the operating system is not supported
+
+    Returns:
+        str: Filename of the MeshKernel library
+    """
+    system = platform.system()
+    if system == "Windows":
+        return "MeshKernelApi.dll"
+    elif system == "Linux":
+        return "libMeshKernelApi.so"
+    else:
+        if not str:
+            system = "Unknown OS"
+        raise OSError(f"Unsupported operating system: {system}")
+
+
+try:
+    from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
+
+    class bdist_wheel(_bdist_wheel):
+        """Class describing our wheel.
+        Basically it says that it is not a pure Python package,
+        but it also does not contain any Python source and
+        therefore works for all Python versions
+        """
+
+        def finalize_options(self):
+            _bdist_wheel.finalize_options(self)
+            # Mark us as not a pure python package
+            self.root_is_pure = False
+
+        def get_tag(self):
+            # We don't contain any python source
+            return "py3", "none", _bdist_wheel.get_tag(self)[2]
+
+except ImportError:
+    bdist_wheel = None
+
+
+class CMakeExtension(Extension):
+    """Class for building a native cmake extension (C++)"""
+
+    def __init__(self, repository):
+        """Constructor of CMakeExtension class
+
+        Args:
+            repository (str): The git repository of the extension to build
+        """
+
+        name = repository.split("/")[-1]
+        super().__init__(name, sources=[])
+        self.repository = repository
+
+
+class build_ext(build_ext_orig):
+    """Class for building an  extension using cmake"""
+
+    def run(self):
+        for ext in self.extensions:
+            self.build_cmake(ext)
+        super().run()
+
+    def build_cmake(self, ext):
+        cwd = str(pathlib.Path().absolute())
+        build_temp = pathlib.Path(self.build_temp)
+
+        build_temp.mkdir(parents=True, exist_ok=True)
+        extdir = pathlib.Path(self.get_ext_fullpath(ext.name))
+        extdir.mkdir(parents=True, exist_ok=True)
+
+        os.chdir(str(build_temp))
+        if not os.path.isdir(ext.name):
+            self.spawn(["git", "clone", ext.repository])
+
+        os.chdir(ext.name)
+
+        if not self.dry_run:
+            library_name = get_library_name()
+            system = platform.system()
+            if system == "Linux":
+                self.spawn(
+                    [
+                        "cmake",
+                        "-S",
+                        ".",
+                        "-B",
+                        "build",
+                        "-DCMAKE_BUILD_TYPE=Release",
+                        "-DADD_UNIT_TESTS_PROJECTS=OFF",
+                    ]
+                )
+                self.spawn(["cmake", "--build", "build", "--config", "Release", "-j4"])
+                meshkernel_path = str(
+                    os.path.join(
+                        *[
+                            pathlib.Path().absolute(),
+                            "build",
+                            "src",
+                            "MeshKernelApi",
+                            library_name,
+                        ]
+                    )
+                )
+                self.spawn(["strip", "--strip-unneeded", meshkernel_path])
+            elif system == "Windows":
+                self.spawn(
+                    [
+                        "cmake",
+                        "-S",
+                        ".",
+                        "-B",
+                        "build",
+                        "-G",
+                        "Visual Studio 16 2019",
+                        "-DCMAKE_BUILD_TYPE=Release",
+                        "-DADD_UNIT_TESTS_PROJECTS=OFF",
+                    ]
+                )
+                self.spawn(["cmake", "--build", "build", "--config", "Release", "-j4"])
+                meshkernel_path = str(
+                    os.path.join(
+                        *[
+                            pathlib.Path().absolute(),
+                            "build",
+                            "src",
+                            "MeshKernelApi",
+                            "Release",
+                            library_name,
+                        ]
+                    )
+                )
+            else:
+                if not str:
+                    system = "Unknown OS"
+                raise OSError(f"Unsupported operating system: {system}")
+
+            destination = os.path.join(*[cwd, "meshkernel", library_name])
+            shutil.copyfile(meshkernel_path, destination)
+
+        os.chdir(cwd)
+
+
+long_description = read("README.md")
+
+setup(
+    name="meshkernel",
+    description="`meshkernel` is a library which can be used to manipulate meshes.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author=__author__,
+    author_email=__author_email__,
+    url="https://github.com/Deltares/MeshKernelPy",
+    license="MIT",
+    platforms="Windows, Linux",
+    install_requires=["numpy"],
+    extras_require={
+        "tests": ["pytest", "pytest-cov", "nbval", "matplotlib"],
+        "lint": [
+            "flake8",
+            "black",
+            "isort",
+        ],
+        "docs": ["sphinx", "sphinx_book_theme", "myst_nb"],
+    },
+    python_requires=">=3.8",
+    package_data={"meshkernel": [get_library_name()]},
+    packages=find_packages(),
+    ext_modules=[CMakeExtension("https://github.com/Deltares/MeshKernel")],
+    cmdclass={"build_ext": build_ext, "bdist_wheel": bdist_wheel},
+    version=get_version("meshkernel/version.py"),
+    classifiers=["Topic :: Scientific/Engineering :: Mathematics"],
+)

meshkernel-2.0.1/meshkernel/version.py

@@ -1 +0,0 @@
-__version__ = "2.0.1"

meshkernel-2.0.1/setup.py

@@ -1,124 +0,0 @@
-import codecs
-import os.path
-import platform
-
-from setuptools import setup
-
-author_dict = {
-    "Julian Hofer": "julian.hofer@deltares.nl",
-    "Prisca van der Sluis": "prisca.vandersluis@deltares.nl",
-}
-__author__ = ", ".join(author_dict.keys())
-__author_email__ = ", ".join(s for _, s in author_dict.items())
-
-
-def read(rel_path: str) -> str:
-    """Used to read a text file
-
-    Args:
-        rel_path (str): Relative path to the file
-
-    Returns:
-        str: File content
-    """
-    here = os.path.abspath(os.path.dirname(__file__))
-    with codecs.open(os.path.join(here, rel_path), "r") as fp:
-        return fp.read()
-
-
-def get_version(rel_path: str) -> str:
-    """Get the version string
-
-    Args:
-        rel_path (str): Relative path to the file
-
-    Raises:
-        RuntimeError: Raised if the version string could not be found
-
-    Returns:
-        str: The version string
-    """
-    for line in read(rel_path).splitlines():
-        if line.startswith("__version__"):
-            delim = '"' if '"' in line else "'"
-            return line.split(delim)[1]
-
-    raise RuntimeError("Unable to find version string.")
-
-
-def get_meshkernel_name() -> str:
-    """Get the filename of the MeshKernel library
-
-    Raises:
-        OSError: If the operating system is not supported
-
-    Returns:
-        str: Filename of the MeshKernel library
-    """
-    system = platform.system()
-    if system == "Windows":
-        return "MeshKernelApi.dll"
-    elif system == "Linux":
-        return "libMeshKernelApi.so"
-    elif system == "Darwin":
-        return "libMeshKernelApi.dylib"
-    else:
-        raise OSError(f"Unsupported operating system: {system}")
-
-
-try:
-    from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
-
-    class bdist_wheel(_bdist_wheel):
-        """Class describing our wheel.
-        Basically it says that it is not a pure Python package,
-        but it also does not contain any Python source and
-        therefore works for all Python versions
-        """
-
-        def finalize_options(self):
-            _bdist_wheel.finalize_options(self)
-            # Mark us as not a pure python package
-            self.root_is_pure = False
-
-        def get_tag(self):
-            python, abi, plat = _bdist_wheel.get_tag(self)
-            # We don't contain any python source
-            python, abi = "py3", "none"
-            return python, abi, plat
-
-except ImportError:
-    bdist_wheel = None
-
-
-long_description = read("README.md")
-
-setup(
-    name="meshkernel",
-    description="`meshkernel` is a library which can be used to manipulate meshes.",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    author=__author__,
-    author_email=__author_email__,
-    url="https://github.com/Deltares/MeshKernelPy",
-    license="MIT",
-    platforms="Windows, Linux",
-    install_requires=["numpy"],
-    extras_require={
-        "tests": ["pytest", "pytest-cov", "nbval", "matplotlib"],
-        "lint": [
-            "flake8",
-            "black",
-            "isort",
-        ],
-        "docs": ["sphinx", "sphinx_book_theme", "myst_nb"],
-    },
-    python_requires=">=3.8",
-    packages=["meshkernel"],
-    package_data={
-        "meshkernel": [get_meshkernel_name()],
-    },
-    cmdclass={"bdist_wheel": bdist_wheel},
-    version=get_version("meshkernel/version.py"),
-    classifiers=["Topic :: Scientific/Engineering :: Mathematics"],
-)