squiggle/packages/squiggle-lang
Ozzie Gooen c2155ef746 Merge branch 'develop' into documentation-refactors-april
* develop: (72 commits)
  cases to handle with new parser. lambdas in arrays and records
  Note duplicate parameters
  Note infinite recursion
  Note infinite recursion
  Add array string and function viewers
  Recurse showTypes
  Pass showTypes and showControls in playground
  do not export private modules from Reducer module
  Allows hiding controls
  sam's monkeying
  fixed function f not bound
  Refactor and rename lambda in partial
  Make error message more descriptive
  Refactor and shrink effect code
  Make a tooltip to restrict users from log scales
  Add Patrial storybook and update partial bindings async
  Lint js
  Format and fix CI bugs
  Hotfix playground chart
  Real log scales
  ...
2022-05-03 11:07:12 -04:00
..
__tests__ cases to handle with new parser. lambdas in arrays and records 2022-05-03 00:44:38 +02:00
benchmark Fix inv tests always checking 0 2022-04-26 18:59:27 -04:00
src Merge branch 'develop' into documentation-refactors-april 2022-05-03 11:07:12 -04:00
.gitignore factored into TestHelpers.ts file 2022-04-19 23:42:24 -04:00
.npmignore v0.2.6: packaging fixed 2022-04-28 15:20:58 -04:00
.prettierignore Fixed the linting of reducer files 2022-04-23 12:25:33 -04:00
bsconfig.json Removed rationale (#410) 2022-04-28 13:19:15 -04:00
jest.config.js Ensure xyShape is ordered by x coordinates when multiplying by negatives 2022-04-25 11:44:50 -04:00
lint.sh fixed or bailed from failing tests; added typescript code coverage to codecov 2022-04-19 22:58:09 -04:00
package.json Merge branch 'develop' into Umur-reducer-dev 2022-05-02 23:21:26 +02:00
README.md v0.2.16: jsImports prop and incremented minimal squiggle-lang 2022-04-30 12:04:03 -04:00
tsconfig.json Colors for loss testing 2022-04-26 16:38:17 -04:00
webpack.config.js Run prettier in squiggle-lang 2022-04-11 10:51:43 +10:00

npm version License: MIT

Squiggle language

An estimation language

Use the npm package

For instance, in a javascript project, you can

yarn add @quri/squiggle-lang
import { run } from "@quri/squiggle-lang";
run(
  "normal(0, 1) * fromSamples([-3,-2,-1,1,2,3,3,3,4,9]"
).value.value.toSparkline().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.

Build for development

We assume that you ran yarn at the monorepo level.

yarn build

yarn bundle is needed for a deployment.

Other:

yarn start  # listens to files and recompiles at every mutation
yarn test

# where o := open in osx and o := xdg-open in linux,
yarn coverage:rescript; o _coverage/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.

This package is mainly written in ReScript, but has a typescript interface.

ReScript has an interesting philosophy of not providing much in the way of effective build tools. Every ReScript file is compiled into .bs.js and .gen.ts files with the same name and same location, and then you can use these files in other .js files to create your program. To generate these files to build the package, you run yarn build.

.gen.ts files are created by the @genType decorator, which creates typescript typings for needed parts of the codebase so that they can be easily used in typescript. These .gen.ts files reference the .bs.js files generated by rescript.