/probabilistic-playground-web

Teaching tool for explaining TopK Theta Sketches and TopK Tuple Sketches

Primary LanguageScalaMIT LicenseMIT

Probabilistic Playground

Purpose

This is an interactive browser-based tool for teaching people about TopK Theta Sketches by allowing them to feed data in and see how they work.

License

This is licensed under the MIT license

Setup instructions

To run the program in a browser you will need to have yarn (or npm) installed.

Before your first run and for your tests to work, you must install the node dependencies with:

yarn install

This example uses Parcel.js as our bundler and dev server, there are lots of other options you might prefer like Webpack, scalajs-bunder, or even just vanilla JavaScript.

We recommend you have two terminal tabs open in the directory containing this README file.

In the first, we'll run sbt.

sbt

From now on, we can recompile the app with fastOptJS or fullOptJS but please note that the tyrianapp.js file in the root is expecting the output from fastOptJS.

Run fastOptJS now to get an initial build in place.

Then start your dev server, with:

yarn start

Now navigate to http://localhost:1234/ to see your site running.

If you leave parcel's dev server running, all you have to do is another fastOptJS or fullOptJS and your app running in the browser should hot-reload the new code.