squiggle/README.md
Quinn Dougherty 1d5a0a30d4 version increment; piggyback README.md improvements
Value: [1e-5 to 6e-4]
2022-04-28 19:06:39 -04:00

3.2 KiB

Squiggle

Packages check npm version - lang npm version - components License: MIT codecov

An estimation language.

Get started

Our deployments

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.