quantified.uncertainty/squiggle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
An estimation language https://www.squiggle-language.com/
687 Commits 74 Branches 5 Tags 16 MiB
ReScript 69.6%
TypeScript 23%
JavaScript 3.5%
CSS 2.1%
Nix 1.6%
Other 0.1%
80b33fcd84
Go to file
Ozzie Gooen 80b33fcd84 Added README to GenericDist library
2022-03-27 21:07:41 -04:00
.github deleted some extraneous comments and todos 2022-03-24 20:06:52 -04:00
packages Added README to GenericDist library 2022-03-27 21:07:41 -04:00
.gitignore .DS_Store 2022-03-24 11:31:52 -04:00
.parcelrc fixed parcel (rebase: fixed MC with index.ts) 2022-03-24 11:28:45 -04:00
CONTRIBUTING.md After pair programming with @Hazelfire, still need to fix playground scripts (rebase: README and index.js) 2022-03-24 11:31:36 -04:00
flake-compat.nix Codium build almost works 2022-03-24 13:52:24 -04:00
flake.lock Codium build almost works 2022-03-24 13:52:24 -04:00
flake.nix needed nodePackages. prefix for npm 2022-03-24 14:55:27 -04:00
LICENSE Added license 2020-02-09 22:27:55 +00:00
package.json removed scripts / yarn run commands 2022-03-24 20:15:23 -04:00
README.md correction in README.md 2022-03-24 20:11:31 -04:00
yarn.lock Add prettier and format 2022-03-23 11:38:01 +11:00

README.md

Squiggle

This is an experiment DSL/language for making probabilistic estimates. The full story can be found here.

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.
  • @quri/playground in packages/playground contains a website for a playground for squiggle. This website is hosted at playground.squiggle-language.com
  • @quri/squiggle-website in packages/website 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 (TODO: is this true?)

yarn

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

codium for rescript

If you have nix installed with flakes enabled, you can build a codium in this repo for rescript development, if you don't want to pollute your machine's global editor with another mode/extension.

nix develop
codium

The nix develop shell also provides yarn.

Contributing

See CONTRIBUTING.md.