For instructions on installing
To develop within this repository,
we recommend using a development shell defined in
In this way,
you will use applications
pinned to same version that other developers and the CI use.
For example, from the project’s root directory, launch the project’s default shell using:
nix develop .
To launch a shell with the haskell toolchain loaded:
nix develop .#haskell
After launching a
you’re in a bash shell with the appropriate applications
in your path.
As of 2022-04-12,
This sections tries to document where and why the structure of certain parts of the repository may not be straightfoward.
This repo uses
ormolufor Haskell formatting. Other repos such as
brittany, but as of 2022-04-22
brittanyyields errors likely due to incompatability with template haskell.
The eventline shape is defined for Rust in this repo, but as of 2022-04-22, the same shapes in Haskell are defined in the
event-data-theorypackage in asclepias.
flake.nixin project root) creates a dhall file than be used to check the integrity of each
Model.dhall) file. This is checked by the
dhall freeze $1 --check --all. This also serves to check that the fragments are up-to-date assuming that the fragments are only created by
build-fragmentsand not edited otherwise.
An important part of this repository are the integration tests that ensure that application logic is correct and that data can be marshalled to/from applications as appropriate.
This page documents checks done in this repo and where they are found.
Serialization of facts and models in Haskell, Dhall, and JSON
Each model needs to call the test functions in a test module.
Yes, though see note.
Eventlines values produced by upstream processes can be marshalled to/from Haskell applications
fact-models and other packages in this repository follow
semantic versioning (MAJOR.MINOR.PATCH),
where you increment:
MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards compatible manner PATCH version when you make backwards compatible bug fixes
In particular, adding new facts or models typically only requires a MINOR update, while changing the shape of existing facts or models should trigger a MAJOR update. Bug fixes to the library functions should only trigger a PATCH update.