Allow user input of json file or free text json (#5)

* Refactoring and started on sidepanel

* Improved layout to include side panel

* Re-worked endpoints and added restapi landing page

* Updated home page

* Removed unused directories

* Added free text input

* Added file upload

* Homepage css update

Co-authored-by: Ben Cannell <[email protected]>
Co-authored-by: Ben Cannell <[email protected]>

Author: 3 people

docker-compose.yml

@@ -2,7 +2,10 @@ version: '3.7'
 
 services:
   fastapi:
-    container_name: jointbuilder
+    container_name: jointrestapi
+    environment:
+      - RESTAPI_URL=http://127.0.0.1:8000
+      - VIEWER_URL=http://127.0.0.1:8050
     restart: always
     build: .
     expose:
@@ -14,7 +17,8 @@ services:
   viewer:
     container_name: jointviewer
     environment:
-      - VTK_MESHER_URL=http://host.docker.internal:8000
+      - RESTAPI_URL=http://host.docker.internal:8000
+      - VIEWER_URL=http://host.docker.internal:8050
     restart: always
     build: .
     expose:

model.json

@@ -0,0 +1,41 @@
+{
+    "name": "TJoint",
+    "joint": {
+        "name": "TJoint",
+        "tubes": [
+            {
+                "name": "Vertical",
+                "axis": {
+                    "point": {
+                        "x": 0.0,
+                        "y": 0.0,
+                        "z": 0.0
+                    },
+                    "vector": {
+                        "x": 0.0,
+                        "y": 0.0,
+                        "z": 5.0
+                    }
+                },
+                "diameter": 0.5
+            },
+            {
+                "name": "Horizontal",
+                "axis": {
+                    "point": {
+                        "x": 0.0,
+                        "y": 0.0,
+                        "z": 3.0
+                    },
+                    "vector": {
+                        "x": 3.0,
+                        "y": 0.0,
+                        "z": 0.0
+                    }
+                },
+                "diameter": 0.25
+            }
+        ],
+        "origin": null
+    }
+}

src/app/constants.py

@@ -0,0 +1,3 @@
+# Set as an environment variable
+RESTAPI_URL = "RESTAPI_URL"
+VIEWER_URL = "VIEWER_URL"

src/app/modelling/model/system/__init__.py src/app/interfaces/examples/__init__.py

@@ -1,7 +1,7 @@
 """Demo models to use for testing"""
-from ..interfaces import *
+from ...interfaces import *
 
-DEMO_MODELS = {
+EXAMPLE_JOINTS = {
     "TJoint": Joint(
         name="TJoint",
         tubes=[
@@ -60,5 +60,5 @@
                 diameter=0.4,
             ),
         ],
-    )
-}
+    ),
+}

src/app/viewer/models.py src/app/interfaces/examples/joints.py

@@ -16,3 +16,15 @@ class Vector3D(BaseModel):
 class Axis3D(BaseModel):
     point: Point3D = ...
     vector: Vector3D = ...
+
+
+class Tubular(BaseModel):
+    name: str = ...
+    axis: Axis3D = ...
+    diameter: float = ...
+
+
+class Joint(BaseModel):
+    name: str = ...
+    tubes: list[Tubular] = ...
+    origin: Point3D | None = None

src/app/interfaces/geometry.py

@@ -1,15 +1,14 @@
 from pydantic import BaseModel
 
-from .geometry import Axis3D, Point3D
+from .geometry import Joint
+from .examples.joints import EXAMPLE_JOINTS
 
 
-class Tubular(BaseModel):
+class Model(BaseModel):
     name: str = ...
-    axis: Axis3D = ...
-    diameter: float = ...
-
-
-class Joint(BaseModel):
-    name: str = ...
-    tubes: list[Tubular] = ...
-    origin: Point3D | None = None
+    joint: Joint = ...
+    class Config:
+        schema_extra = {
+            "name": "TJoint",
+            "joint": EXAMPLE_JOINTS["TJoint"].json()
+        }

src/app/interfaces/model.py

@@ -0,0 +1,10 @@
+import json
+from typing import Any
+
+def validate_json(json_str: str, check_type: Any) -> dict:
+    if type(json_str) is str:
+        json_data = json.loads(json_str)
+    else:
+        json_data = json_str
+    check_type.validate(json_data)
+    return json_data

src/app/interfaces/validation.py

@@ -1,13 +1,14 @@
 import gmsh
 import math
 
-from app.interfaces.model import Tubular
+from app.interfaces import Tubular
 
 from .vectors import angle_between
 from ...interfaces.geometry import *
 
 FACTORY = gmsh.model.occ
 
+
 def rotatexy(dimTags: list[tuple[int, int]], origin: Point3D, vector: Vector3D):
     xangle = angle_between([0, 0, 1], [0, vector.y, vector.z])
     FACTORY.rotate(dimTags, origin.x, origin.y, origin.z, 1, 0, 0, xangle)
@@ -19,6 +20,7 @@ def rotatexy(dimTags: list[tuple[int, int]], origin: Point3D, vector: Vector3D):
     print(vector)
     print(xangle, yangle)
 
+
 def add_tube(tube: Tubular) -> tuple[int, int]:
     origin = tube.axis.point
     vector = tube.axis.vector
@@ -40,7 +42,7 @@ def add_tube(tube: Tubular) -> tuple[int, int]:
     print(ring)
     rotatexy([(1, ring)], origin, vector)
     pipe = FACTORY.addPipe([(1, ring)], wire)
-    
+
     # We delete the source surface, and increase the number of sub-edges for a
     # nicer display of the geometry:
     FACTORY.remove([(1, ring)])

src/app/modelling/mesher/cylinder.py

@@ -9,10 +9,12 @@
 
 FACTORY = gmsh.model.occ
 
+
 def mesh_tubular(tube: Tubular) -> tuple[int, int]:
     """Adds tubular geometry and returns tag id"""
     return add_cylinder(tube)
 
+
 def mesh_joint(joint: Joint) -> dict[str, tuple[int, int]]:
     joint_mesh = {tube.name: mesh_tubular(tube) for tube in joint.tubes}
     FACTORY.synchronize()
@@ -21,6 +23,7 @@ def mesh_joint(joint: Joint) -> dict[str, tuple[int, int]]:
         gmsh.model.setPhysicalName(dim, gid, k)
     return joint_mesh
 
+
 @contextmanager
 def mesh_model(joint: Joint) -> gmsh.model.mesh:
     try:
@@ -37,7 +40,9 @@ def mesh_model(joint: Joint) -> gmsh.model.mesh:
             FACTORY.synchronize()
             if len(intersect[0]) > 0:
                 # if there is an intersection, do what you want to do.
-                FACTORY.remove(intersect[0], True)  # remove created intersection objects
+                FACTORY.remove(
+                    intersect[0], True
+                )  # remove created intersection objects
                 FACTORY.synchronize()
             else:
                 pass

src/app/modelling/mesher/mesh.py

@@ -1,22 +1,24 @@
 import numpy as np
 
+
 def unit_vector(vector):
-    """ Returns the unit vector of the vector.  """
+    """Returns the unit vector of the vector."""
     return vector / np.linalg.norm(vector)
 
+
 def angle_between(v1, v2):
-    """ Returns the angle in radians between vectors 'v1' and 'v2'::
+    """Returns the angle in radians between vectors 'v1' and 'v2'::
 
-            >>> angle_between((1, 0, 0), (0, 1, 0))
-            1.5707963267948966
-            >>> angle_between((1, 0, 0), (1, 0, 0))
-            0.0
-            >>> angle_between((1, 0, 0), (-1, 0, 0))
-            3.141592653589793
+    >>> angle_between((1, 0, 0), (0, 1, 0))
+    1.5707963267948966
+    >>> angle_between((1, 0, 0), (1, 0, 0))
+    0.0
+    >>> angle_between((1, 0, 0), (-1, 0, 0))
+    3.141592653589793
     """
     v1_u = unit_vector(v1)
     v2_u = unit_vector(v2)
     angle = np.arccos(np.clip(np.dot(v1_u, v2_u), -1.0, 1.0))
     if np.isnan(angle):
         return 0.0
-    return angle
+    return angle

src/app/modelling/mesher/vectors.py

@@ -0,0 +1,87 @@
+from fastapi import APIRouter, BackgroundTasks
+from fastapi.responses import HTMLResponse
+
+import requests
+import os
+
+from app.constants import VIEWER_URL, RESTAPI_URL
+
+router = APIRouter()
+
+def ping_viewer():
+    requests.get(VIEWER_URL)
+
+@router.get("/", response_class=HTMLResponse)
+async def root(background_tasks: BackgroundTasks):
+    # Wake up viewer service by pinging it
+    background_tasks.add_task(ping_viewer)
+
+    url_example = f"{os.environ[RESTAPI_URL]}/examples/TJoint"
+    url_docs = f"{os.environ[RESTAPI_URL]}/docs"
+    url_viewer = f"{os.environ[VIEWER_URL]}"
+    html_content = f"""
+    <html>
+        <head>
+            <title>Joint Meshing REST API</title>
+            <!--using same theme as Dash Flatly-->
+            <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/flatly/bootstrap.min.css" rel="stylesheet">
+            <style>
+            body {{
+                padding: 80px
+            }}
+            h1 {{
+                padding-bottom: 40px
+            }}
+            .padbutton {{
+                padding-top: 5px;
+                padding-bottom: 5px;
+            }}
+            .credits {{
+                display: block;
+                position: absolute;
+                right: 0px;
+                bottom: 0px;
+                padding: 40px;
+            }}
+            </style>
+        </head>
+        <body>
+            <h1 sty>Joint Meshing REST API</h1>
+            <div class="row"> 
+                <div class="col-lg-4">
+                    <div class="card text-white bg-primary mb-3" style="max-width: 20rem; height: 100%;">
+                        <div class="card-header">RestAPI</div>
+                        <div class="card-body">
+                            <h4 class="card-title">Create joint meshes</h4>
+                            <p class="card-text">A REST API is available to generate joint meshes from json input.</p>
+                            <p class="card-text">This REST API is developed using <a href='https://fastapi.tiangolo.com'>FastAPI</a>.</p>
+                            <div class="padbutton">
+                                <button type="button" onclick="location.href='{url_docs}'" class="btn btn-success btn-lg">Docs</button>
+                            </div>
+                            <div class="padbutton">
+                                <button type="button" onclick="location.href='{url_example}'" class="btn btn-success btn-lg">Example response</button>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+                <div class="col-lg-4">
+                    <div class="card text-white bg-primary mb-3" style="max-width: 20rem; height: 100%;">
+                        <div class="card-header">Viewer</div>
+                        <div class="card-body">
+                            <h4 class="card-title">View joint meshes</h4>
+                            <p class="card-text">You can create <b>and</b> view joint meshes using a user interface. This uses the REST API under the hood.</p>
+                            <p class="card-text">This viewer is developed using <a href='https://dash.plotly.com/vtk'>Dash VTK</a>.</p>
+                            <div class="padbutton">
+                                <button type="button" onclick="location.href='{url_viewer}'" class="btn btn-success btn-lg">Viewer</button>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="credits">
+                <span class="badge bg-light"><i>Templates by <a href='https://bootswatch.com/flatly'>https://bootswatch.com/flatly</a> :)</span>
+            </div>
+        </body>
+    </html>
+    """
+    return HTMLResponse(content=html_content, status_code=200)

src/app/server/dependencies/security.py

@@ -0,0 +1,45 @@
+from fastapi import APIRouter, HTTPException
+from fastapi.responses import StreamingResponse
+
+import io
+import json
+
+from app.converters.encoder import NpEncoder
+from app.interfaces.examples.joints import EXAMPLE_JOINTS
+from app.server.worker.worker import run_job, Worker
+from app.server.worker.job import Job
+
+from ...interfaces import Joint, Model
+from ...interfaces.examples.joints import EXAMPLE_JOINTS
+
+router = APIRouter()
+# get worker singleton
+worker = Worker()
+
+def do_meshing(joint: Joint) -> StreamingResponse:
+    job = Job(joint)
+    try:
+        job = run_job(worker, job)
+
+        def iterfile():
+            with io.StringIO() as file_like:
+                json.dump(job.mesh, file_like, cls=NpEncoder)
+                file_like.seek(0)
+                yield from file_like
+
+        return StreamingResponse(iterfile(), media_type="application/json")
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=f"Error while generating mesh: {e}")
+
+@router.get("/examples/{jointname}")
+def mesh_example(jointname: str):
+    if jointname not in EXAMPLE_JOINTS:
+        raise HTTPException(
+            status_code=404, detail=f"Joint model {jointname} not found"
+        )
+    return do_meshing(EXAMPLE_JOINTS[jointname])
+
+@router.post("/meshmodel")
+def mesh_model(model: Model):
+    # do some validation here!
+    return do_meshing(model.joint)