squiggle/README.md

Squiggle

An estimation language.

Get started

• Gallery
• Squiggle playground
• Language basics
• Squiggle functions source of truth
• Known bugs
• Original lesswrong sequence
• Author your squiggle models as Observable notebooks

Our deployments

• website/docs prod: https://squiggle-language.com
• website/docs staging: https://develop--squiggle-documentation.netlify.app/
• components storybook prod: https://squiggle-components.netlify.app/
• components storybook staging: https://develop--squiggle-components.netlify.app/
• legacy (2020) playground: https://playground.squiggle-language.com

Packages

This monorepo has several packages that can be used for various purposes. All the packages can be found in packages.

• @quri/squiggle-lang in packages/squiggle-lang contains the core language, particularly an interface to parse squiggle expressions and return descriptions of distributions or results.
• @quri/squiggle-components in packages/components contains React components that can be passed squiggle strings as props, and return a presentation of the result of the calculation.
• packages/website is the main descriptive website for squiggle, it is hosted at squiggle-language.com.

The playground depends on the components library which then depends on the language. This means that if you wish to work on the components library, you will need to build (no need to bundle) the language, and as of this writing playground doesn't really work.

Develop

For any project in the repo, begin by running yarn in the top level

yarn

See packages/*/README.md to work with whatever project you're interested in.

Contributing

See CONTRIBUTING.md.