@quri/squiggle-lang

Squiggle language

An estimation language

Use the npm package

For instance, in a javascript project, you can

npm add @quri/squiggle-lang # or `yarn add`, or `pnpm add`

The @quri/squiggle-lang package exports a single function, run, which given a string of Squiggle code, will execute the code and return any exports and the environment created from the squiggle code.

import { run, defaultEnvironment } from "@quri/squiggle-lang";
run(
  "normal(0, 1) * SampleSet.fromList([-3, 2,-1,1,2,3,3,3,4,9])"
).result.value.value.toSparkline(defaultEnvironment).value;

However, for most use cases you'll prefer to use our library of React components, and let your app transitively depend on @quri/squiggle-lang.

run has two optional arguments. The first optional argument allows you to set sampling settings for Squiggle when representing distributions. The second optional argument allows you to pass an environment configuration that allows you to control distribution settings.

The return type of run is a bit complicated. We highly recommend using typescript when using this library to help navigate the return type.

Build for development

We assume that you installed turborepo and ran pnpm i.

npx turbo build

Other:

pnpm dev  # listens to files and recompiles at every mutation
pnpm test

# where o := open in osx and o := xdg-open in linux,
pnpm coverage:local; o coverage/lcov-report/index.html  # produces coverage report and opens it in browser

Distributing this package or using this package from other monorepo packages

As it says in the other packages/*/README.mds, building this package is an essential step of building other packages.

Information

Squiggle is a language for representing probability distributions, as well as functions that return probability distributions. Its original intended use is for improving epistemics around EA decisions.

This package, @quri/squiggle-lang, contains the core language of squiggle. The main feature revolves around evaluating squiggle expressions. Currently the package only exports a single function, named "run", which from a squiggle string returns an object representing the result of the evaluation.

If using this package for tests or as a dependency, typescript typings are available and recommended to be used.