deploy: 56c013c

herbie-fp · Jan 29, 2024 · 5bd89a1 · 5bd89a1
1 parent 7a34330
commit 5bd89a1
Show file tree

Hide file tree

Showing 180 changed files with 13,801 additions and 429,709 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,24 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/semi": "off",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn",
+        "semi": "off"
+    },
+    "ignorePatterns": [
+        "out",
+        "dist",
+        "**/*.d.ts"
+    ]
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+out
+dist
+node_modules
+.vscode-test/
+*.vsix
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,35 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/dist/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		},
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js",
+				"${workspaceFolder}/dist/**/*.js"
+			],
+			"preLaunchTask": "tasks: watch-tests"
+		}
+	]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,15 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false, // set this to true to hide the "out" folder with the compiled JS files
+        "dist": false // set this to true to hide the "dist" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true, // set this to false to include "out" folder in search results
+        "dist": true // set this to false to include "dist" folder in search results
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off",
+    "cmake.configureOnOpen": false,
+    "livePreview.defaultPreviewPath": "/index.html"
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,40 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": "$ts-webpack-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never",
+				"group": "watchers"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		},
+		{
+			"type": "npm",
+			"script": "watch-tests",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never",
+				"group": "watchers"
+			},
+			"group": "build"
+		},
+		{
+			"label": "tasks: watch-tests",
+			"dependsOn": [
+				"npm: watch",
+				"npm: watch-tests"
+			],
+			"problemMatcher": []
+		}
+	]
+}
diff --git a/.vscodeignore b/.vscodeignore
@@ -0,0 +1,13 @@
+.vscode/**
+.vscode-test/**
+out/**
+node_modules/**
+src/**
+.gitignore
+.yarnrc
+webpack.config.js
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.ts
diff --git a/0108e89c9003e8c14ea3.woff b/0108e89c9003e8c14ea3.woff
diff --git a/02271ec5cb9f5b4588ac.woff b/02271ec5cb9f5b4588ac.woff
diff --git a/073b3402d036714b4370.woff b/073b3402d036714b4370.woff
diff --git a/0c3b8929d377c0e9b2f3.woff b/0c3b8929d377c0e9b2f3.woff
diff --git a/172d3529b26f8cedef6b.woff2 b/172d3529b26f8cedef6b.woff2
diff --git a/20f389c4120be058d80a.woff2 b/20f389c4120be058d80a.woff2
diff --git a/2960900c4f271311eb36.woff2 b/2960900c4f271311eb36.woff2
diff --git a/2f7bc363fc5424ebda59.ttf b/2f7bc363fc5424ebda59.ttf
diff --git a/354501bac435c3264834.woff b/354501bac435c3264834.woff
diff --git a/39890742bc957b368704.woff2 b/39890742bc957b368704.woff2
diff --git a/3a99e70aee4076660d38.woff b/3a99e70aee4076660d38.woff
diff --git a/3f07ed67f06c720120ce.woff b/3f07ed67f06c720120ce.woff
diff --git a/428978dc7837d46de091.woff b/428978dc7837d46de091.woff
diff --git a/4ad7c7e8bb8d10a34bb7.ttf b/4ad7c7e8bb8d10a34bb7.ttf
diff --git a/4c6b94fd1d07f8beff7c.woff b/4c6b94fd1d07f8beff7c.woff
diff --git a/4c761b3711973ab04edf.ttf b/4c761b3711973ab04edf.ttf
diff --git a/4f35fbcc9ee8614c2bcc.woff b/4f35fbcc9ee8614c2bcc.woff
diff --git a/57f5c1837853986ea1db.ttf b/57f5c1837853986ea1db.ttf
diff --git a/5b49f4993ae22d7975b4.ttf b/5b49f4993ae22d7975b4.ttf
diff --git a/6d3d25f4820d0da8f01f.woff2 b/6d3d25f4820d0da8f01f.woff2
diff --git a/6de7d4b539221a49e9e2.ttf b/6de7d4b539221a49e9e2.ttf
diff --git a/6eec866c69313624be60.woff2 b/6eec866c69313624be60.woff2
diff --git a/6fdf0ac577be0ba82a4c.woff b/6fdf0ac577be0ba82a4c.woff
diff --git a/73ea273a72f4aca30ca5.woff2 b/73ea273a72f4aca30ca5.woff2
diff --git a/7489a2fbfb9bfe704420.ttf b/7489a2fbfb9bfe704420.ttf
diff --git a/7947224e8a9914fa332b.woff b/7947224e8a9914fa332b.woff
diff --git a/7d393d382f3e7fb1c637.woff2 b/7d393d382f3e7fb1c637.woff2
diff --git a/7e873d3833eb108a0758.ttf b/7e873d3833eb108a0758.ttf
diff --git a/8169508bf58f8bd92ad8.ttf b/8169508bf58f8bd92ad8.ttf
diff --git a/828abcb200061cffbaae.ttf b/828abcb200061cffbaae.ttf
diff --git a/853be92419a6c3766b9a.ttf b/853be92419a6c3766b9a.ttf
diff --git a/8a5f936332e8028c7278.ttf b/8a5f936332e8028c7278.ttf
diff --git a/8d593cfaa96238d5e2f8.woff b/8d593cfaa96238d5e2f8.woff
diff --git a/8d6b6822586eea3d3b20.ttf b/8d6b6822586eea3d3b20.ttf
diff --git a/931d67ea207ab37ee693.woff2 b/931d67ea207ab37ee693.woff2
diff --git a/95591a929f0d32aa282a.woff2 b/95591a929f0d32aa282a.woff2
diff --git a/96759856b4e70f3a8338.woff b/96759856b4e70f3a8338.woff
diff --git a/9eba1d77abcf2aa6e94e.ttf b/9eba1d77abcf2aa6e94e.ttf
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "interactive-herbie" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+- Initial release
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Edward Misback 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,152 @@
+# Odyssey: An Interactive Numerics Workbench 
+#### [[Video tutorial (8.5 min)]](https://youtu.be/jsjGuM2KK50) [[Setup]](#running-odyssey)
+
+Odyssey is a tool for interactively rewriting numerical expressions to reduce floating-point error.
+
+<img src="doc/overview.gif" width=600/>
+<br>
+<br>
+
+**Before using Odyssey, please see [Running Odyssey](#running-odyssey) below to install dependencies.**
+
+## Table of Contents
+- [Features](#features)
+- [Running Odyssey](#running-odyssey)
+- [Submitting Feedback and Getting Help](#submitting-feedback-and-getting-help)
+- [Release Notes](#release-notes)
+- [For Developers](#for-developers)
+
+## Features
+
+Odyssey displays the *local error* of expressions. Local error shows how different subexpressions contribute to the total error for an input.
+
+<img src="doc/local_error.gif" width=600/>
+<br>
+<br>
+
+Odyssey generates rewriting suggestions with the state-of-the-art [Herbie](https://herbie.uwplse.org/demo/) floating-point expression rewriting tool.
+
+<img src="doc/ask_herbie.gif" width=600/>
+<br>
+<br>
+
+Derivations of Herbie's rewrites are also available.
+
+<img src="doc/derivation.gif" width=600/>
+<br>
+<br>
+
+The sample range of the expression can be adjusted to fit your use case.
+
+<!-- TODO gif of Odyssey showing adjusting the sample range for sqrt(x + 1) - sqrt(x) -->
+<img src="doc/resample.gif" width=600/>
+<br>
+<br>
+
+A full walkthrough of Odyssey is available in the [video tutorial](https://youtu.be/jsjGuM2KK50). 
+
+If you have any questions about features, please [open an issue](https://github.com/herbie-fp/odyssey/issues/new) on Github.
+
+## Running Odyssey
+
+Odyssey runs as a VSCode extension. You can install it from the VSCode Marketplace [here](https://marketplace.visualstudio.com/items?itemName=herbie-fp.odyssey-fp), but first follow the instructions below to install dependencies. 
+
+### Dependencies
+Odyssey uses a [Herbie](https://herbie.uwplse.org) server to analyze expressions and currently requires you to bring your own Herbie instance. After following the [Herbie installation instructions](https://herbie.uwplse.org/doc/latest/installing.html), you can run a Herbie server with
+```bash
+$ herbie web --port 8000 --quiet
+# Response should look like:
+Herbie 2.0 with seed 552322303
+Find help on https://herbie.uwplse.org/, exit with Ctrl-C
+Your Web application is running at http://localhost:8000.
+Stop this program at any time to terminate the Web Server.
+```
+
+### Running the VSCode extension
+
+After starting the Herbie server, run Odyssey from the VSCode command palette by clicking on VSCode and using **Ctrl/Command-Shift-P > Odyssey: Herbie.**
+
+The server status shown in Odyssey should have the text "Connected."
+
+If the server status is red with the text "No Server", Odyssey can't connect to the Herbie server.
+
+If needed, you can adjust the server address where Odyssey looks for Herbie by clicking on the server status. Make sure that the port Odyssey is connecting to is the same one Herbie is being hosted on.
+
+### (Alternative) Running as a standalone web application
+
+Odyssey can also run as a standalone web application.
+
+First, you'll need to install node from https://nodejs.org/en/download/.
+
+Next, clone this repo and build the application:
+```bash
+$ git clone https://github.com/herbie-fp/odyssey
+$ cd odyssey
+$ npm install
+$ npm run compile
+```
+
+Then, after starting the Herbie server, run an HTTP server to serve the `index.html` file:
+```bash
+$ npx serve -p 3000
+```
+
+# Submitting Feedback and Getting Help
+Please submit any feedback or bug reports by [opening an issue on this repo](https://github.com/herbie-fp/odyssey/issues/new).
+
+# Release Notes
+
+### 1.0.0
+* First public release
+
+<!-- TODO add more release notes -->
+
+### 0.4.0
+
+* Rename repo + extension
+* Still unofficial; expecting to release 1.0 at the beginning of August
+
+### 0.1.0
+
+First major post-study 1 version
+
+# For Developers
+
+## Setting up a development environment
+```bash
+$ npm install
+# Then use command/control+shift+B to start the auto-compile task
+# Each time compilation finishes, you should see a message like "webpack 5.82.1 compiled with 1 warning in 31769 ms"
+```
+
+### Testing the extension
+Use the "Run and Debug" tab to start an instance of VSCode with the most recent code.
+
+You can see changes to the frontend (`webview/index.ts`) by simply refreshing the webview, but **changes to the host (`extension.ts`) will only show if the debugger is restarted.**
+
+### Publishing the extension:
+
+Get publication key from @elmisback, then:
+
+```bash
+# update "version" in package.json and commit, then
+$ npm run publish
+```
+
+<!-- ## Extension Settings
+
+Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
+
+For example:
+
+This extension contributes the following settings:
+
+* `myExtension.enable`: enable/disable this extension
+* `myExtension.thing`: set to `blah` to do something -->
+
+-----------------------------------------------------------------------------------------------------------
+<!-- ## Following extension guidelines
+
+Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
+
+* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
diff --git a/a1abf90dfd72792a577a.woff2 b/a1abf90dfd72792a577a.woff2
diff --git a/aeffd8025cba3647f1a6.woff b/aeffd8025cba3647f1a6.woff
diff --git a/b257a18c016f37ee4543.ttf b/b257a18c016f37ee4543.ttf
diff --git a/b9cd458ac6d5889ff9c3.woff b/b9cd458ac6d5889ff9c3.woff
diff --git a/bf2d440b3a42ea78a998.ttf b/bf2d440b3a42ea78a998.ttf
diff --git a/c295e7f71970f03c0549.woff2 b/c295e7f71970f03c0549.woff2
diff --git a/c5c02d763c89380dcb4e.ttf b/c5c02d763c89380dcb4e.ttf
diff --git a/c81d1b2a4b75d3eded60.woff2 b/c81d1b2a4b75d3eded60.woff2
diff --git a/cd5e231e0cc53b2cb2c0.woff2 b/cd5e231e0cc53b2cb2c0.woff2
diff --git a/d562e886c52f12660a41.woff b/d562e886c52f12660a41.woff
diff --git a/d6484fce1ef428d5bd94.woff2 b/d6484fce1ef428d5bd94.woff2
diff --git a/d757c535a2e5902f1325.woff b/d757c535a2e5902f1325.woff
diff --git a/db074fa22cf224af93d7.woff b/db074fa22cf224af93d7.woff
diff --git a/dcbcbd93bac0470b462d.woff2 b/dcbcbd93bac0470b462d.woff2
diff --git a/doc/ask_herbie.gif b/doc/ask_herbie.gif
diff --git a/doc/derivation.gif b/doc/derivation.gif
diff --git a/doc/local_error.gif b/doc/local_error.gif
diff --git a/doc/overview.gif b/doc/overview.gif
diff --git a/doc/resample.gif b/doc/resample.gif
diff --git a/e1951519f6f0596f7356.woff2 b/e1951519f6f0596f7356.woff2
diff --git a/e418bf257af1052628d8.woff2 b/e418bf257af1052628d8.woff2
diff --git a/ed305b5434865e06ffde.ttf b/ed305b5434865e06ffde.ttf