58 lines
3.2 KiB
Markdown
58 lines
3.2 KiB
Markdown
# Squiggle
|
|
|
|
[](https://github.com/quantified-uncertainty/squiggle/actions/workflows/ci.yml)
|
|
[](https://www.npmjs.com/package/@quri/squiggle-lang)
|
|
[](https://www.npmjs.com/package/@quri/squiggle-components)
|
|
[](https://github.com/quantified-uncertainty/squiggle/blob/develop/LICENSE)
|
|
[](https://codecov.io/gh/quantified-uncertainty/squiggle)
|
|
|
|
_An estimation language_.
|
|
|
|
## Get started
|
|
|
|
- [Gallery](https://www.squiggle-language.com/docs/Discussions/Gallery)
|
|
- [Squiggle playground](https://squiggle-language.com/playground)
|
|
- [Language basics](https://www.squiggle-language.com/docs/Features/Language)
|
|
- [Squiggle functions source of truth](https://www.squiggle-language.com/docs/Features/Functions)
|
|
- [Known bugs](https://www.squiggle-language.com/docs/Discussions/Bugs)
|
|
- [Original lesswrong sequence](https://www.lesswrong.com/s/rDe8QE5NvXcZYzgZ3)
|
|
- [Author your squiggle models as Observable notebooks](https://observablehq.com/@hazelfire/squiggle)
|
|
|
|
## Our deployments
|
|
|
|
- **website/docs prod**: https://squiggle-language.com [](https://app.netlify.com/sites/squiggle-documentation/deploys)
|
|
- **website/docs staging**: https://develop--squiggle-documentation.netlify.app/
|
|
- **components storybook prod**: https://squiggle-components.netlify.app/ [](https://app.netlify.com/sites/squiggle-components/deploys)
|
|
- **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
|
|
|
|
```sh
|
|
yarn
|
|
```
|
|
|
|
See `packages/*/README.md` to work with whatever project you're interested in.
|
|
|
|
# Contributing
|
|
|
|
See `CONTRIBUTING.md`.
|