Merge pull request #219 from noaa-ocs-modeling/refactor/internal

Remove use of JigsawPy data structure and make Jigsaw optional

Author: felicio93

.github/workflows/documentation.yml

@@ -26,9 +26,7 @@ jobs:
           python=3.12
     - name: Install dependencies
       shell: bash -l {0}
-      run: |
-        python ./setup.py install_jigsaw
-        pip install .[documentation]
+      run: pip install .[documentation]
     - name: Retrieve latest version from Git tags
       uses: mtkennerly/dunamai-action@v1
       with:

.github/workflows/functional_test.yml

@@ -43,7 +43,7 @@ jobs:
 
     - name: Install other dependencies
       shell: bash -l {0}
-      run: pip install .
+      run: pip install .[testing]
 
     - name: Prepare example DEM
       if: runner.os != 'Windows'
@@ -112,7 +112,11 @@ jobs:
         name: remesh-bydem-results-${{ matrix.python-version }}
         path: remeshed.2dm
         retention-days: 7
-
+    # Ensure engines are installed so tests don't skip
+    - name: Install Engine Dependencies
+      shell: bash -l {0}
+      run: pip install gmsh triangle
+  
     - name: Run Python API tests
       shell: bash -el {0}
-      run: python -m unittest discover tests/api -p "*.py"
+      run: python -m unittest discover tests

.github/workflows/functional_test_2.yml

@@ -34,9 +34,7 @@ jobs:
           python=3.12
     - name: Install dependencies
       shell: bash -l {0}
-      run: |
-        python ./setup.py install_jigsaw
-        pip install .[testing]
+      run: pip install .[testing]
     - name: Analysing the code with pylint
       shell: bash -l {0}
       run: |

.github/workflows/pylint.yml

@@ -1,9 +1,3 @@
-# CMake build cache for Jigsaw
-submodules/jigsaw-python/external/jigsaw/build
-
-# temporary old version of jigsaw
-submodules/jigsaw-geo-python
-
 # files generated or used by examples
 examples
 

.gitignore

@@ -1,3 +0,0 @@
-[submodule "submodules/jigsaw-python"]
-	path = submodules/jigsaw-python
-	url = https://github.com/dengwirda/jigsaw-python.git

.gitmodules

@@ -4,8 +4,7 @@
 
 ## OCSMesh
 OCSMesh is a Python package for processing DEM data into georeferenced
-unstructured meshes using the
-[jigsaw-python](https://github.com/dengwirda/jigsaw-python) library.
+unstructured meshes using different meshing engine libraries.
 
 ### Installation
 Two ways of installing OCSMesh are described below:
@@ -16,36 +15,28 @@ use [`conda`](https://docs.conda.io/en/latest/miniconda.html#linux-installers)
 with the `environment.yml` file provided in the repo to install
 required libraries.
 
-The Jigsaw library and its Python wrapper  must be instlled
-before OCSMesh can be used. Jigsaw is available on `conda-forge`
-channel.
+You need to make sure you've installed the mesh engine you'd like to
+use (i.e. Jigsaw, Triangle, or Gmsh).
 
 First you need to download the `environment.yml` file.
-
 ```
 wget https://raw.githubusercontent.com/noaa-ocs-modeling/OCSMesh/main/environment.yml
 
 conda env create -f environment.yml -n your-env-name
 conda activate your-env-name
 
-conda install -y -c conda-forge jigsawpy
 pip install ocsmesh
 ```
 
 #### From GitHub repo
-OCSMesh can be installed from the GitHub repository as well.
-After downloading the repo, you need to first install Jigsaw using
-the script provided in OCSMesh repo by calling:
-`./setup.py install_jigsaw` in the OCSMesh root directory.
-Then OCSMesh can be installed. 
+You need to make sure you've installed the mesh engine you'd like to
+use (i.e. Jigsaw, Triangle, or Gmsh).
 
+OCSMesh can be installed from the GitHub repository as follows:
 ```
 git clone https://github.com/noaa-ocs-modeling/ocsmesh
 cd ocsmesh
-python ./setup.py install_jigsaw # To install latest Jigsaw from GitHub
-python ./setup.py install # Installs the OCSMesh library to the current Python environment
-# OR
-python ./setup.py develop # Run this if you are a developer.
+pip install .[all]
 ```
 
 #### Requirements
@@ -71,5 +62,3 @@ DOI : http://dx.doi.org/10.2139/ssrn.5226658
 
 ## Disclaimer
 This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.
-
-