Merge pull request #223 from noaa-ocs-modeling/version_2_1

OCSMesh Version 2.1

Author: felicio93

.pylintrc

@@ -29,10 +29,7 @@ disable=arguments-differ,
 
 [TYPECHECK]
 ignored-modules=matplotlib, matplotlib.cm
-generated-members=ocsmesh.driver.JigsawDriver.hfun,
-                  ocsmesh.driver.JigsawDriver.geom,
-                  ocsmesh.driver.JigsawDriver.opts,
-                  ocsmesh.hfun.hfun.Hfun.*,
+generated-members=ocsmesh.hfun.hfun.Hfun.*,
                   ocsmesh.mesh.base.BaseMesh._msh_t,
                   ocsmesh.mesh.mesh.EuclideanMesh._boundaries,
                   ocsmesh.mesh.mesh.Mesh.*

README.md

@@ -16,7 +16,7 @@ with the `environment.yml` file provided in the repo to install
 required libraries.
 
 You need to make sure you've installed the mesh engine you'd like to
-use (i.e. Jigsaw, Triangle, or Gmsh).
+use (e.g., Triangle or Gmsh).
 
 First you need to download the `environment.yml` file.
 ```
@@ -30,7 +30,7 @@ pip install ocsmesh
 
 #### From GitHub repo
 You need to make sure you've installed the mesh engine you'd like to
-use (i.e. Jigsaw, Triangle, or Gmsh).
+use (e.g., Triangle or Gmsh).
 
 OCSMesh can be installed from the GitHub repository as follows:
 ```

environment.yml

@@ -23,6 +23,5 @@ dependencies:
   - pytz
   - colored-traceback<=0.3.0
   - typing-extensions
-  - jigsawpy
   - gmsh
   - python-gmsh

ocsmesh/cli/mesh_upgrader.py

@@ -124,8 +124,7 @@ def run(self, args):
 
         meshdata_hfun = hfun_from_disk.meshdata()
 
-        # TODO: Make jigsaw an option
-        engine = get_mesh_engine('jigsaw', verbose=1)
+        engine = get_mesh_engine('gmsh', verbose=1)
         meshdata = engine.generate(
             read_gdf.to_crs(meshdata_hfun.crs), meshdata_hfun,
         )

ocsmesh/cli/remesh.py

@@ -304,8 +304,7 @@ def run(self, args):
         boxes = [i.get_bbox(crs=shape_geom.crs) for i in geom_rast_list]
         region_of_interest = MultiPolygon(boxes)
 
-        # TODO: Make jigsaw an option
-        engine = get_mesh_engine('jigsaw')
+        engine = get_mesh_engine('gmsh')
         meshdata_remeshed = engine.remesh(
             deepcopy(meshdata_init),
             gpd.GeoSeries(region_of_interest, crs=shape_geom.crs),

ocsmesh/cli/remesh_by_shape_factor.py

@@ -279,8 +279,7 @@ def run(self, args):
             raise ValueError(
                 "CRS for geometry, hfun and init mesh is not the same")
 
-        # TODO: Make jigsaw an option
-        engine = get_mesh_engine('jigsaw')
+        engine = get_mesh_engine('gmsh')
         if all(obj is not None for obj in [init_meshdata, refine_polys]):
             meshdata_remeshed = engine.remesh(
                 init_meshdata,

ocsmesh/cli/subset_n_combine.py

@@ -284,8 +284,7 @@ def _calculate_mesh_size_function(
         hfun_cdt_sz = deepcopy(hfun_cdt.meshdata().values) / approx_elem_per_width
         meshdata_cdt.values = hfun_cdt_sz
 
-        # TODO: Make jigsaw an option
-        engine = get_mesh_engine('jigsaw')
+        engine = get_mesh_engine('gmsh')
         # Note we alraeady know the buffer_crs is NOT geographic
         meshdata_domain_rep = engine.generate(
             gpd.GeoSeries(buffer_domain),
@@ -321,8 +320,7 @@ def _generate_mesh_for_buffer_region(
         assert not buffer_crs.is_geographic
         assert buffer_crs == meshdata_hfun_buffer.crs
 
-        # TODO: Make jigsaw an option
-        engine = get_mesh_engine('jigsaw')
+        engine = get_mesh_engine('gmsh')
         # Note we alraeady know the buffer_crs is NOT geographic
         meshdata_buf_apprx = engine.generate(
             gpd.GeoSeries(buffer_polygon),

ocsmesh/driver.py

@@ -43,7 +43,7 @@ def __init__(
             Coordinate reference system for the output.
             If None, defaults to EPSG:4326.
         engine_name : str
-            Name of the engine ('jigsaw', 'triangle', 'gmsh').
+            Name of the engine ('triangle', 'gmsh').
         **engine_kwargs : dict
             Options to pass to the engine's Option class.
             Common options:

ocsmesh/engines/factory.py

@@ -5,17 +5,13 @@
 from ocsmesh.engines.gmsh import (
     GmshEngine, GmshOptions
 )
-from ocsmesh.engines.jigsaw import (
-    JigsawEngine, JigsawOptions
-)
 from ocsmesh.engines.triangle import (
     TriangleEngine, TriangleOptions
 )
 # from ocsmesh.engines.triangle_wrapper import ...
 
 _ENGINES = {
     'gmsh': (GmshEngine, GmshOptions),
-    'jigsaw': (JigsawEngine, JigsawOptions),
     'triangle': (TriangleEngine, TriangleOptions),
 }
 
@@ -28,7 +24,7 @@ def get_mesh_engine(engine_name: str, **engine_kwargs: Any) -> BaseMeshEngine:
     Parameters
     ----------
     engine_name : str
-        Name of the engine ('gmsh', 'jigsaw', 'triangle').
+        Name of the engine ('gmsh', 'triangle').
     **engine_kwargs : dict
         Options to pass to the engine's Option class.
     """