{
"cells": [
{
"cell_type": "markdown",
"id": "e216b98f",
"metadata": {
"papermill": {
"duration": 0.002166,
"end_time": "2026-05-27T20:02:34.365166+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.363000+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"# Waveguide box\n",
"\n",
"Simple elongated box waveguide mesh with two waveports.\n",
"\n",
"Generates a rectangular waveguide (elongated box) where:\n",
"- The two end faces are labeled \"waveport_1\" and \"waveport_2\"\n",
"- The four lateral surfaces are labeled \"metal\"\n",
"\n",
"Our goal is to measure the s parameters."
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "a2184d13",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.371816Z",
"iopub.status.busy": "2026-05-27T20:02:34.371629Z",
"iopub.status.idle": "2026-05-27T20:02:34.741536Z",
"shell.execute_reply": "2026-05-27T20:02:34.740958Z"
},
"papermill": {
"duration": 0.373195,
"end_time": "2026-05-27T20:02:34.742494+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.369299+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [],
"source": [
"import gmsh\n",
"import math\n",
"import os\n",
"import sys\n",
"from pathlib import Path\n",
"\n",
"from palacetoolkit.viz import view_mesh\n",
"from palacetoolkit.geometry import extract_tag, xmin, xmax, ymin, ymax, zmin, zmax\n",
"from palacetoolkit.mesh import refine_near_surfaces\n",
"from palacetoolkit.simulation import Simulation, run_palace"
]
},
{
"cell_type": "markdown",
"id": "9805464a",
"metadata": {
"papermill": {
"duration": 0.003947,
"end_time": "2026-05-27T20:02:34.748151+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.744204+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Parameters\n",
"- filename : Output mesh filename\n",
"- width : width of the waveguide in meters\n",
"- height : height of the waveguide in meters\n",
"- length : length of the waveguide in meters"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "c27265c6",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.752273Z",
"iopub.status.busy": "2026-05-27T20:02:34.751991Z",
"iopub.status.idle": "2026-05-27T20:02:34.754840Z",
"shell.execute_reply": "2026-05-27T20:02:34.754354Z"
},
"papermill": {
"duration": 0.005714,
"end_time": "2026-05-27T20:02:34.755497+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.749783+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [],
"source": [
"filename=\"waveguide_box.msh\"\n",
"\n",
"# Default dimensions of the waveguide box (wr-90 standard)\n",
"width=22.86e-3 \n",
"height=10.16e-3 \n",
"length=100e-3 "
]
},
{
"cell_type": "markdown",
"id": "2fc8f9cf",
"metadata": {
"papermill": {
"duration": 0.001371,
"end_time": "2026-05-27T20:02:34.758590+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.757219+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Initialization of the model"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "0f9278fa",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.762272Z",
"iopub.status.busy": "2026-05-27T20:02:34.762116Z",
"iopub.status.idle": "2026-05-27T20:02:34.765354Z",
"shell.execute_reply": "2026-05-27T20:02:34.764948Z"
},
"papermill": {
"duration": 0.005903,
"end_time": "2026-05-27T20:02:34.765916+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.760013+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [],
"source": [
"gmsh.initialize()\n",
"gmsh.model.add(\"waveguide_box\")\n",
"kernel = gmsh.model.occ"
]
},
{
"cell_type": "markdown",
"id": "0a892f96",
"metadata": {
"papermill": {
"duration": 0.001325,
"end_time": "2026-05-27T20:02:34.768759+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.767434+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Geometry definition"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "fa41cbdd",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.772148Z",
"iopub.status.busy": "2026-05-27T20:02:34.772008Z",
"iopub.status.idle": "2026-05-27T20:02:34.774974Z",
"shell.execute_reply": "2026-05-27T20:02:34.774470Z"
},
"papermill": {
"duration": 0.005294,
"end_time": "2026-05-27T20:02:34.775403+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.770109+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [],
"source": [
"# Create an elongated box centered at the origin\n",
"\n",
"# addBox(x, y, z, dx, dy, dz) — (x,y,z) is the corner\n",
"box = kernel.addBox(\n",
" -width / 2, -height / 2, 0,\n",
" width, height, length,\n",
")\n",
"\n",
"kernel.synchronize()"
]
},
{
"cell_type": "markdown",
"id": "c4e6aa04",
"metadata": {
"papermill": {
"duration": 0.001355,
"end_time": "2026-05-27T20:02:34.778449+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.777094+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Identifying Geometric Entities and Domains"
]
},
{
"cell_type": "code",
"execution_count": 5,
"id": "5df9a4aa",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.781991Z",
"iopub.status.busy": "2026-05-27T20:02:34.781831Z",
"iopub.status.idle": "2026-05-27T20:02:34.785532Z",
"shell.execute_reply": "2026-05-27T20:02:34.785127Z"
},
"papermill": {
"duration": 0.00622,
"end_time": "2026-05-27T20:02:34.786041+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.779821+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [],
"source": [
"# Identify surfaces by their bounding box positions\n",
"all_surfaces = gmsh.model.getEntities(2)\n",
"\n",
"waveport_1_tags = [] # face at z = 0\n",
"waveport_2_tags = [] # face at z = length\n",
"metal_tags = [] # the four lateral faces\n",
"\n",
"eps = 1e-6\n",
"\n",
"for dimtag in all_surfaces:\n",
"\n",
" if abs(zmin(dimtag) - 0.0) < eps and abs(zmax(dimtag) - 0.0) < eps:\n",
" waveport_1_tags.append(dimtag)\n",
" elif abs(zmin(dimtag) - length) < eps and abs(zmax(dimtag) - length) < eps:\n",
" waveport_2_tags.append(dimtag)\n",
" else:\n",
" metal_tags.append(dimtag)\n",
"\n",
"assert len(waveport_1_tags) == 1, f\"Expected 1 waveport_1 face, found {len(waveport_1_tags)}\"\n",
"assert len(waveport_2_tags) == 1, f\"Expected 1 waveport_2 face, found {len(waveport_2_tags)}\"\n",
"assert len(metal_tags) == 4, f\"Expected 4 metal faces, found {len(metal_tags)}\""
]
},
{
"cell_type": "markdown",
"id": "04bc34a5",
"metadata": {
"papermill": {
"duration": 0.00136,
"end_time": "2026-05-27T20:02:34.788919+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.787559+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Defining Physical Groups\n",
"To prepare the geometry for export to Palace, we must define \"Physical Groups.\" These groups serve as labels that the solver uses to identify boundaries (surfaces) and domains (volumes) for applying physics settings, such as excitation ports or material properties."
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "cdc7ab2c",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.792267Z",
"iopub.status.busy": "2026-05-27T20:02:34.792146Z",
"iopub.status.idle": "2026-05-27T20:02:34.795264Z",
"shell.execute_reply": "2026-05-27T20:02:34.794877Z"
},
"papermill": {
"duration": 0.005468,
"end_time": "2026-05-27T20:02:34.795748+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.790280+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [],
"source": [
"# Physical groups (these become boundary attributes in Palace).\n",
"# Use deterministic IDs so generated configs are stable and match the reference JSON.\n",
"pg_waveport_1 = gmsh.model.addPhysicalGroup(2, [x[1] for x in waveport_1_tags], 1, name=\"waveport_1\")\n",
"pg_waveport_2 = gmsh.model.addPhysicalGroup(2, [x[1] for x in waveport_2_tags], 2, name=\"waveport_2\")\n",
"pg_metal = gmsh.model.addPhysicalGroup(2, [x[1] for x in metal_tags], 3, name=\"metal\")\n",
"\n",
"# Volume physical group\n",
"all_volumes = gmsh.model.getEntities(3)\n",
"vol_tags = [tag for _, tag in all_volumes]\n",
"pg_volume = gmsh.model.addPhysicalGroup(3, vol_tags, 4, name=\"waveguide_volume\")\n",
"\n",
"# Map physical group names to their tags for later use.\n",
"pg_map = {\n",
" \"waveport_1\": pg_waveport_1,\n",
" \"waveport_2\": pg_waveport_2,\n",
" \"metal\": pg_metal,\n",
" \"volume\": pg_volume\n",
"}\n",
"\n",
"assert pg_map == {\"waveport_1\": 1, \"waveport_2\": 2, \"metal\": 3, \"volume\": 4}"
]
},
{
"cell_type": "markdown",
"id": "0f2368d3",
"metadata": {
"papermill": {
"duration": 0.001388,
"end_time": "2026-05-27T20:02:34.798583+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.797195+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Mesh Generation and Export\n",
"Next, we define the mesh resolution based on our operating frequency (10 GHz) and generate the final mesh for the Palace solver.\n",
"\n",
"- Refinement: We ensure higher mesh density near the waveports to capture electromagnetic behavior accurately.\n",
"- Settings: We use the Frontal-Delaunay algorithm and set the mesh to first-order elements.\n",
"- Export: The mesh is saved in the Gmsh 2.2 ASCII format, which is required for compatibility with Palace."
]
},
{
"cell_type": "code",
"execution_count": 7,
"id": "66e29ac7",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:34.801956Z",
"iopub.status.busy": "2026-05-27T20:02:34.801810Z",
"iopub.status.idle": "2026-05-27T20:02:35.605473Z",
"shell.execute_reply": "2026-05-27T20:02:35.604885Z"
},
"papermill": {
"duration": 0.816578,
"end_time": "2026-05-27T20:02:35.616506+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:34.799928+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
" ppw_near=20 ppw_far=10\n",
" SizeMax=0.0030 transition=0.0075\n",
" global: 8 curves, SizeMin=0.0015\n",
"Info : Meshing 1D...\n",
"Info : [ 0%] Meshing curve 1 (Line)\n",
"Info : [ 10%] Meshing curve 2 (Line)\n",
"Info : [ 20%] Meshing curve 3 (Line)\n",
"Info : [ 30%] Meshing curve 4 (Line)\n",
"Info : [ 40%] Meshing curve 5 (Line)\n",
"Info : [ 50%] Meshing curve 6 (Line)\n",
"Info : [ 60%] Meshing curve 7 (Line)\n",
"Info : [ 60%] Meshing curve 8 (Line)\n",
"Info : [ 70%] Meshing curve 9 (Line)\n",
"Info : [ 80%] Meshing curve 10 (Line)\n",
"Info : [ 90%] Meshing curve 11 (Line)\n",
"Info : [100%] Meshing curve 12 (Line)\n",
"Info : Done meshing 1D (Wall 0.0374193s, CPU 0.037833s)\n",
"Info : Meshing 2D...\n",
"Info : [ 0%] Meshing surface 1 (Plane, Frontal-Delaunay)\n",
"Info : [ 20%] Meshing surface 2 (Plane, Frontal-Delaunay)\n",
"Info : [ 40%] Meshing surface 3 (Plane, Frontal-Delaunay)\n",
"Info : [ 60%] Meshing surface 4 (Plane, Frontal-Delaunay)\n",
"Info : [ 70%] Meshing surface 5 (Plane, Frontal-Delaunay)\n",
"Info : [ 90%] Meshing surface 6 (Plane, Frontal-Delaunay)\n",
"Info : Done meshing 2D (Wall 0.0184283s, CPU 0.018458s)\n",
"Info : Meshing 3D...\n",
"Info : 3D Meshing 1 volume with 1 connected component\n",
"Info : Tetrahedrizing 1266 nodes...\n",
"Info : Done tetrahedrizing 1274 nodes (Wall 0.00834981s, CPU 0.007382s)\n",
"Info : Reconstructing mesh...\n",
"Info : - Creating surface mesh\n",
"Info : - Identifying boundary edges\n",
"Info : - Recovering boundary\n",
"Info : Done reconstructing mesh (Wall 0.0181882s, CPU 0.013253s)\n",
"Info : Found volume 1\n",
"Info : It. 0 - 0 nodes created - worst tet radius 2.00763 (nodes removed 0 0)\n",
"Info : 3D refinement terminated (1649 nodes total):\n",
"Info : - 0 Delaunay cavities modified for star shapeness\n",
"Info : - 0 nodes could not be inserted\n",
"Info : - 6009 tetrahedra created in 0.010736 sec. (559703 tets/s)\n",
"Info : 0 node relocations\n",
"Info : Done meshing 3D (Wall 0.0399752s, CPU 0.033199s)\n",
"Info : Optimizing mesh...\n",
"Info : Optimizing volume 1\n",
"Info : Optimization starts (volume = 2.32258e-05) with worst = 0.0117629 / average = 0.761057:\n",
"Info : 0.00 < quality < 0.10 : 31 elements\n",
"Info : 0.10 < quality < 0.20 : 48 elements\n",
"Info : 0.20 < quality < 0.30 : 84 elements\n",
"Info : 0.30 < quality < 0.40 : 82 elements\n",
"Info : 0.40 < quality < 0.50 : 132 elements\n",
"Info : 0.50 < quality < 0.60 : 293 elements\n",
"Info : 0.60 < quality < 0.70 : 918 elements\n",
"Info : 0.70 < quality < 0.80 : 1658 elements\n",
"Info : 0.80 < quality < 0.90 : 1726 elements\n",
"Info : 0.90 < quality < 1.00 : 1037 elements\n",
"Info : 159 edge swaps, 2 node relocations (volume = 2.32258e-05): worst = 0.248964 / average = 0.777845 (Wall 0.00127162s, CPU 0.001314s)\n",
"Info : 161 edge swaps, 2 node relocations (volume = 2.32258e-05): worst = 0.300339 / average = 0.778112 (Wall 0.00153182s, CPU 0.00159s)\n",
"Info : No ill-shaped tets in the mesh :-)\n",
"Info : 0.00 < quality < 0.10 : 0 elements\n",
"Info : 0.10 < quality < 0.20 : 0 elements\n",
"Info : 0.20 < quality < 0.30 : 0 elements\n",
"Info : 0.30 < quality < 0.40 : 82 elements\n",
"Info : 0.40 < quality < 0.50 : 125 elements\n",
"Info : 0.50 < quality < 0.60 : 293 elements\n",
"Info : 0.60 < quality < 0.70 : 916 elements\n",
"Info : 0.70 < quality < 0.80 : 1643 elements\n",
"Info : 0.80 < quality < 0.90 : 1763 elements\n",
"Info : 0.90 < quality < 1.00 : 1041 elements\n",
"Info : Done optimizing mesh (Wall 0.00429291s, CPU 0.00431s)\n",
"Info : 1649 nodes 8635 elements\n",
"Info : Writing '/home/martin/Desktop/PalaceToolkit/docs/examples/waveguide_box.msh'...\n",
"Info : Done writing '/home/martin/Desktop/PalaceToolkit/docs/examples/waveguide_box.msh'\n",
"Loading mesh file: waveguide_box.msh\n",
"Groups to render transparent: ['air_none', 'air_plastic_enclosure']\n",
"\n",
"Mesh loaded successfully with 2 cell blocks\n",
"Found 2528 triangles total\n",
"Physical group tags in mesh: {1: 'waveport_1', 2: 'waveport_2', 3: 'metal'}\n"
]
},
{
"data": {
"text/html": [
""
],
"text/plain": [
""
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"def _generate_waveguide_box_mesh():\n",
" freq = 10e9 # 10 GHz\n",
" c = 3e8 # speed of light in vacuum\n",
" wavelength = c / freq\n",
"\n",
" refine_near_surfaces(waveport_1_tags + waveport_2_tags, ppw_far=10, ppw_near=20, wavelength=wavelength)\n",
"\n",
" # Meshing\n",
" gmsh.option.setNumber(\"Mesh.Algorithm\", 6) # Frontal-Delaunay for 2D\n",
" gmsh.option.setNumber(\"Mesh.Algorithm3D\", 2) # Frontal-Delaunay for 3D\n",
"\n",
" gmsh.model.mesh.generate(3)\n",
" gmsh.model.mesh.setOrder(1)\n",
"\n",
" # Output in Gmsh 2.2 ASCII format (Palace compatible)\n",
" gmsh.option.setNumber(\"Mesh.MshFileVersion\", 2.2)\n",
" gmsh.option.setNumber(\"Mesh.Binary\", 0)\n",
"\n",
" script_dir = os.getcwd()\n",
" output_path = os.path.join(script_dir, filename)\n",
" gmsh.write(output_path)\n",
"\n",
"_generate_waveguide_box_mesh()\n",
"\n",
"gmsh.finalize()\n",
"view_mesh(filename)"
]
},
{
"cell_type": "markdown",
"id": "f33aab9d",
"metadata": {
"papermill": {
"duration": 0.015728,
"end_time": "2026-05-27T20:02:35.651207+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:35.635479+00:00",
"status": "completed"
},
"tags": []
},
"source": [
"### Write a Palace JSON config for a simple hollow waveguide.\n",
"- output_file: destination JSON path.\n",
"- freq_min: start frequency [GHz].\n",
"- freq_max: end frequency [GHz].\n",
"- freq_step: frequency step [GHz]."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "8ad8d012",
"metadata": {
"execution": {
"iopub.execute_input": "2026-05-27T20:02:35.681655Z",
"iopub.status.busy": "2026-05-27T20:02:35.681318Z",
"iopub.status.idle": "2026-05-27T20:02:35.688207Z",
"shell.execute_reply": "2026-05-27T20:02:35.687731Z"
},
"papermill": {
"duration": 0.022413,
"end_time": "2026-05-27T20:02:35.688795+00:00",
"exception": false,
"start_time": "2026-05-27T20:02:35.666382+00:00",
"status": "completed"
},
"tags": []
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Palace config written to /home/martin/Desktop/PalaceToolkit/docs/examples/waveguide_box.json\n",
" Running: /home/martin/.cache/palacetoolkit/runtime/palace-cpu-v0.1.2/bin/palace --serial /home/martin/Desktop/PalaceToolkit/docs/examples/waveguide_box.json\n",
">> /home/martin/.cache/palacetoolkit/runtime/palace-cpu-v0.1.2/bin/palace-x86_64.bin /home/martin/Desktop/PalaceToolkit/docs/examples/waveguide_box.json\n",
"\n",
"_____________ _______\n",
"_____ __ \\____ __ /____ ____________\n",
"____ /_/ / __ ` / / __ ` / ___/ _ \\\n",
"___ _____/ /_/ / / /_/ / /__/ ___/\n",
" /__/ \\___,__/__/\\___,__/\\_____\\_____/\n",
"\n",
"\n",
"\u001b[38;2;255;255;000m--> Warning!\u001b[0m\n",
"Output folder is not empty; program will overwrite content! (postpro/waveguide_box)\n",
"Git changeset ID: v0.16.1-51-g4f2e2d97\n",
"Running with 1 MPI process, 1 OpenMP thread\n",
"Device configuration: omp,cpu\n",
"Memory configuration: host-std\n",
"libCEED backend: /cpu/self/xsmm/blocked\n",
"\n",
"\n",
"Characteristic length and time scales:\n",
" Lc = 1.000e-01 m, tc = 3.336e-01 ns\n",
"Finished partitioning mesh into 1 subdomain\n",
"\n",
"Mesh curvature order: 1\n",
"Mesh bounding box:\n",
" (Xmin, Ymin, Zmin) = (-1.143e-02, -5.080e-03, +0.000e+00) m\n",
" (Xmax, Ymax, Zmax) = (+1.143e-02, +5.080e-03, +1.000e-01) m\n",
"\n",
"Parallel Mesh Stats:\n",
"\n",
" minimum average maximum total\n",
" vertices 1649 1649 1649 1649\n",
" edges 8775 8775 8775 8775\n",
" faces 12990 12990 12990 12990\n",
" elements 5863 5863 5863 5863\n",
" neighbors 0 0 0\n",
"\n",
" minimum maximum\n",
" h 0.0121339 0.0474389\n",
" kappa 1.03977 7.87187\n",
"\n",
"Estimated current per-rank memory usage is: Min. 48.8M, Max. 48.8M, Avg. 48.8M, Total 48.8M\n",
"Estimated current per-node memory usage is: Min. 48.8M, Max. 48.8M, Avg. 48.8M, Total 48.8M\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"\n",
"\n",
"Verification failed: (da >= 0 && db >= 0 && da != db) is false:\n",
" --> Unexpected wave port geometry for normalization!\n",
" ... in function: palace::WavePortData::WavePortData(const palace::config::WavePortData&, const palace::config::BoundaryData&, const palace::config::DomainData&, palace::ProblemType, const palace::config::LinearSolverData&, const palace::Units&, const palace::MaterialOperator&, mfem::ParFiniteElementSpace&, mfem::ParFiniteElementSpace&, const mfem::Array&)\n",
" ... in file: /tmp/palace-src/palace/models/waveportoperator.cpp:553\n",
"\n",
"--------------------------------------------------------------------------\n",
"MPI_ABORT was invoked on rank 0 in communicator MPI_COMM_WORLD\n",
"with errorcode 1.\n",
"\n",
"NOTE: invoking MPI_ABORT causes Open MPI to kill all MPI processes.\n",
"You may or may not see output from other processes, depending on\n",
"exactly when Open MPI kills them.\n",
"--------------------------------------------------------------------------\n"
]
},
{
"ename": "RuntimeError",
"evalue": "Palace exited with code 1",
"output_type": "error",
"traceback": [
"\u001b[31m---------------------------------------------------------------------------\u001b[39m",
"\u001b[31mRuntimeError\u001b[39m Traceback (most recent call last)",
"\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[8]\u001b[39m\u001b[32m, line 84\u001b[39m\n\u001b[32m 80\u001b[39m \u001b[38;5;28;01mexcept\u001b[39;00m RuntimeError \u001b[38;5;28;01mas\u001b[39;00m exc:\n\u001b[32m 81\u001b[39m \u001b[38;5;28;01mif\u001b[39;00m os.environ.get(\u001b[33m\"DOCS_BUILD\"\u001b[39m) == \u001b[33m\"1\"\u001b[39m:\n\u001b[32m 82\u001b[39m print(f\"Palace run skipped in docs build due to runtime failure: {exc}\")\n\u001b[32m 83\u001b[39m \u001b[38;5;28;01melse\u001b[39;00m:\n\u001b[32m---> \u001b[39m\u001b[32m84\u001b[39m \u001b[38;5;28;01mraise\u001b[39;00m\n",
"\u001b[36mFile \u001b[39m\u001b[32m~/Desktop/PalaceToolkit/src/palacetoolkit/simulation.py:412\u001b[39m, in \u001b[36mrun_palace\u001b[39m\u001b[34m(config_file, num_procs, work_dir, sif_path)\u001b[39m\n\u001b[32m 410\u001b[39m result = subprocess.run(cmd, cwd=work_dir, capture_output=\u001b[38;5;28;01mFalse\u001b[39;00m, env=run_env)\n\u001b[32m 411\u001b[39m \u001b[38;5;28;01mif\u001b[39;00m result.returncode != \u001b[32m0\u001b[39m:\n\u001b[32m--> \u001b[39m\u001b[32m412\u001b[39m \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mRuntimeError\u001b[39;00m(\u001b[33mf\u001b[39m\u001b[33m\"\u001b[39m\u001b[33mPalace exited with code \u001b[39m\u001b[38;5;132;01m{\u001b[39;00mresult.returncode\u001b[38;5;132;01m}\u001b[39;00m\u001b[33m\"\u001b[39m)\n\u001b[32m 413\u001b[39m \u001b[38;5;28;01mreturn\u001b[39;00m\n\u001b[32m 415\u001b[39m \u001b[38;5;28;01mif\u001b[39;00m palace_sif_path \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m:\n",
"\u001b[31mRuntimeError\u001b[39m: Palace exited with code 1"
]
}
],
"source": [
"output_file: str = \"waveguide_box.json\"\n",
"freq_min: float = 6.0\n",
"freq_max: float = 15.0\n",
"freq_step: float = 0.5\n",
"\n",
"if os.environ.get(\"DOCS_BUILD\") == \"1\":\n",
" # Keep docs notebook execution fast while still attempting a real Palace solve.\n",
" freq_min = 10.0\n",
" freq_max = 10.0\n",
" freq_step = 1.0\n",
"\n",
"output_stem = Path(output_file).stem\n",
"\n",
"sim = Simulation(output_dir=os.getcwd(), apply_mesh_options=False)\n",
"sim.config = {\n",
" \"Problem\": {\n",
" \"Type\": \"Driven\",\n",
" \"Verbose\": 2,\n",
" \"Output\": f\"postpro/{output_stem}\",\n",
" },\n",
" \"Model\": {\n",
" \"Mesh\": filename,\n",
" \"L0\": 1.0,\n",
" \"Refinement\": {},\n",
" },\n",
" \"Domains\": {\n",
" \"Materials\": [\n",
" {\n",
" \"Attributes\": [pg_map[\"volume\"]],\n",
" \"Permeability\": 1.0,\n",
" \"Permittivity\": 1.0,\n",
" \"LossTan\": 0.0,\n",
" }\n",
" ],\n",
" },\n",
" \"Boundaries\": {\n",
" \"PEC\": {\n",
" \"Attributes\": [pg_map[\"metal\"]],\n",
" },\n",
" \"WavePort\": [\n",
" {\n",
" \"Index\": 1,\n",
" \"Attributes\": [pg_map[\"waveport_1\"]],\n",
" \"Mode\": 1,\n",
" \"Offset\": 0.0,\n",
" \"Excitation\": True,\n",
" },\n",
" {\n",
" \"Index\": 2,\n",
" \"Attributes\": [pg_map[\"waveport_2\"]],\n",
" \"Mode\": 1,\n",
" \"Offset\": 0.0,\n",
" },\n",
" ],\n",
" },\n",
" \"Solver\": {\n",
" \"Order\": 2,\n",
" \"Device\": \"CPU\",\n",
" \"Driven\": {\n",
" \"MinFreq\": freq_min,\n",
" \"MaxFreq\": freq_max,\n",
" \"FreqStep\": freq_step,\n",
" \"SaveStep\": 1,\n",
" \"AdaptiveTol\": 0.001,\n",
" },\n",
" \"Linear\": {\n",
" \"Type\": \"Default\",\n",
" \"KSPType\": \"GMRES\",\n",
" \"Tol\": 1e-8,\n",
" \"MaxIts\": 200,\n",
" },\n",
" },\n",
"}\n",
"\n",
"config_path = str(sim.write_config(output_file))\n",
"\n",
"run_palace(config_path, num_procs=8, work_dir=os.getcwd())"
]
}
],
"metadata": {
"kernelspec": {
"display_name": ".venv",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.3"
},
"papermill": {
"default_parameters": {},
"duration": 2.740987,
"end_time": "2026-05-27T20:02:36.319859+00:00",
"environment_variables": {},
"exception": null,
"input_path": "docs/examples/waveguide_box.ipynb",
"output_path": "docs/examples/waveguide_box.ipynb",
"parameters": {},
"start_time": "2026-05-27T20:02:33.578872+00:00",
"version": "2.7.0"
}
},
"nbformat": 4,
"nbformat_minor": 5
}