2020-11-12 20:58:09 +00:00
|
|
|
# Squiggle
|
2020-02-05 21:09:27 +00:00
|
|
|
|
2020-11-12 20:58:09 +00:00
|
|
|
This is an experiment DSL/language for making probabilistic estimates.
|
2020-03-09 13:29:18 +00:00
|
|
|
|
2022-02-28 23:59:48 +00:00
|
|
|
This monorepo has several packages that can be used for various purposes. All
|
|
|
|
|
the packages can be found in `packages`.
|
2020-03-09 13:29:18 +00:00
|
|
|
|
2022-03-23 22:34:50 +00:00
|
|
|
`@quri/squiggle-lang` in `packages/squiggle-lang` contains the core language, particularly
|
2022-02-28 23:59:48 +00:00
|
|
|
an interface to parse squiggle expressions and return descriptions of distributions
|
|
|
|
|
or results.
|
|
|
|
|
|
2022-03-23 22:34:50 +00:00
|
|
|
`@quri/squiggle-components` in `packages/components` contains React components that
|
2022-02-28 23:59:48 +00:00
|
|
|
can be passed squiggle strings as props, and return a presentation of the result
|
|
|
|
|
of the calculation.
|
|
|
|
|
|
2022-03-23 22:34:50 +00:00
|
|
|
`@quri/playground` in `packages/playground` contains a website for a playground
|
2022-02-28 23:59:48 +00:00
|
|
|
for squiggle. This website is hosted at `playground.squiggle-language.com`
|
|
|
|
|
|
2022-03-23 22:34:50 +00:00
|
|
|
`@quri/squiggle-website` in `packages/website` The main descriptive website for squiggle,
|
2022-02-28 23:59:48 +00:00
|
|
|
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 package the language, and for the playground to work, you will need to package
|
|
|
|
|
the components library and the playground.
|
|
|
|
|
|
2022-03-23 22:34:50 +00:00
|
|
|
# Develop
|
2022-02-28 23:59:48 +00:00
|
|
|
|
2022-03-23 22:34:50 +00:00
|
|
|
For any project in the repo, begin by running `yarn` in the top level
|
2022-03-23 14:39:32 +00:00
|
|
|
|
|
|
|
|
``` sh
|
2022-03-23 22:34:50 +00:00
|
|
|
yarn
|
2022-03-23 14:39:32 +00:00
|
|
|
```
|
2022-03-23 22:34:50 +00:00
|
|
|
|
|
|
|
|
See `packages/*/README.md` to work with whatever project you're interested in.
|
