add pre-commit and CI config

Author: mamoll

.github/workflows/build_wheels.yml

@@ -0,0 +1,23 @@
+name: Build Wheels
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v5
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.3.0
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: check-toml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black

plannerarena/app.py

@@ -118,8 +118,10 @@ def data():
                 ui.update_nav_panel("navbar", "database", "show")
                 ui.update_navset("navbar", "database")
                 ui.notification_show(
-                "No default database found. Upload a database first.", duration=5, type="warning"
-            )
+                    "No default database found. Upload a database first.",
+                    duration=5,
+                    type="warning",
+                )
             return load_database(DATABASE)
         return load_database(file[0]["datapath"])
 
@@ -136,9 +138,12 @@ def _():
     regression_server("regression", data)
     database_info_server("database_info", data)
 
+
 # create the Shiny app. The shiny command line app looks for this variable
 app = App(app_ui, app_server, static_assets=ASSET_DIR)
 
+
 def run():
     from shiny._main import run_app
+
     run_app(app, host="127.0.0.1", port=8888)

plannerarena/database.py

@@ -107,7 +107,6 @@ def database_info_ui():
 def database_info_server(
     input: Inputs, output: Outputs, session: Session, data: reactive.Value
 ):
-
     @output
     @render.data_frame
     def benchmark_info():

plannerarena/www/help.md

@@ -224,7 +224,7 @@ The ompl_benchmark_statistics.py script can produce a series of plots from a dat
   - *date:* the date on which the experiment was performed.
   - *seed:* the random seed used.
   - *setup:* a string containing a “print-out” of all the settings of the SimpleSetup object used during benchmarking.
-  
+
   Any additional columns are assumed to be numeric values corresponding to experimental hyperparameters. This can be useful to show planner performance as a function of, e.g., number of revolute joints for a parametric robot arm or number of obstacles in parametric environment. Planner Arena will show a selection widget for each hyperparameter. The user can choose to (1) aggregate planner runs over all hyperparameter values, (2) show performance separated out by hyperparameter value, or (3) show performance for one selected hyperparameter value.
 - **plannerConfigs**. There are a number of planner types (such as PRM and RRT), but each planner can typically be configured with a number of parameters. A planner configuration refers to a planner type with specific parameter settings. The `plannerConfigs` table contains the following information:
   - *id:* an ID used in the `runs` table to denote that a given planner configuration was used for a run.
@@ -238,8 +238,8 @@ The ompl_benchmark_statistics.py script can produce a series of plots from a dat
   - *id:* ID of the run
   - *experimentid:* ID of the experiment to which this run belonged.
   - *plannerid:* ID of the planner configuration used for this run.
-  
-  In addition, there will be many benchmark statistics. None are *required*, but the OMPL planners all report the properties described above such as time, memory, solution length, simplification time, etc. It is possible that not all planners report the same properties. In that case, planners that do not report such properties will have NULL values in the corresponding fields. Users can programmatically define new properties that can get logged for each run in OMPL. 
+
+  In addition, there will be many benchmark statistics. None are *required*, but the OMPL planners all report the properties described above such as time, memory, solution length, simplification time, etc. It is possible that not all planners report the same properties. In that case, planners that do not report such properties will have NULL values in the corresponding fields. Users can programmatically define new properties that can get logged for each run in OMPL.
 - **progress**. Some planners (such as RRT*) can also periodically report properties *during* a run. This can be useful to analyze the convergence or growth rate. The `progress` table contains the following information:
   - *runid:* the ID of the run for which progress data was tracked.
   - *time:* the time (in sec.) at which the property was measured.
@@ -248,6 +248,5 @@ The ompl_benchmark_statistics.py script can produce a series of plots from a dat
   - *iterations:* the number of iterations.
   - *collision_checks:* the number of collision checks (or, more precisely, the number state validator calls).
   - *best_cost:* the cost of the best solution found so far.
-  
+
   As with run properties, users can programmatically define their own progress properties that will be logged during each run of a planner.
-  

plannerarena/www/plannerarena.css

@@ -169,4 +169,4 @@ label[disabled] {
 .navbar:not(.fixed-bottom):not(.navbar-fixed-bottom):not(.navbar-fixed-bottom)+div>.tab-content>.tab-pane {
  --bslib-navbar-margin: 0px;
 margin-top: var(--bslib-navbar-margin);
-}
+}

pyproject.toml

@@ -42,4 +42,8 @@ requires = ["setuptools >= 77.0.3"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.package-data]
-plannerarena = ["www/ga.js", "www/help.md", "www/plannerarena.css"]
+plannerarena = ["www/ga.js", "www/help.md", "www/plannerarena.css"]
+
+[tool.cibuildwheel]
+build-verbosity = 1
+skip = ""

shiny-server.conf

@@ -7,4 +7,4 @@ server {
     log_dir /var/log/shiny-server;
     directory_index off;
   }
-}
+}