Project Layout

The Sprite repository is organized as follows:

conda/: The scaffold of a conda package: a recipe for Sprite and one for the Curry front end. conda/README.md describes them and what remains open. Nothing is published.
configure: The script used to configure Sprite. Run this before running make. Doing so creates a file Make.config.
curry/: The built-in Curry library. curry/lib/ holds the sources: a copy of the library of the pinned PAKCS release, Sprite’s own modules, the license of the origin, and the pinned ICurry products. See curry/README.md.
docs/: Files used to build documentation. Say cd docs && make html to build HTML documentation.
examples/: Examples demonstrating Sprite.
extern/: External projects used by Sprite. The GIT submodules subcommand populates this on the first build.

install/ (dynamically created)

The staging area created by the make stage command. Sprite is installed here for use in testing and building help documents. It is safe to remove this directory.

The installation tree created by make install also follows this layout.

bin/: Executable files installed by Sprite.
curry/: The built-in Curry library. Sprite automatically adds this to the end of the search path used to locate Curry modules.
lib/: The Sprite runtime libraries. The contents of this directory are needed to run programs compiled by Sprite.
python/: The Sprite Python API. Contains the code loaded by the Python statement import curry.
sysconfig/: System variables set during configuration.
tools/: Links to external programs used by Sprite.

object-root/ (dynamically created)

The directory containing all build products such as object files, libraries, and help documents. It is safe to remove this directory, for instance, to reclaim disk space or prepare for a clean build.

overlay*.tgz

Contains the prebuilt ICurry and FlatCurry files of the test programs for a specific version of PAKCS. Say make overlay to apply the overlay. The archive also holds the FlatCurry interfaces of the Curry library. The oracle tests of the FlatCurry-to-ICurry port read them; see The Curry Compilation Pipeline. The ICurry products of the library itself are committed under curry/lib.

Warning

It is important to choose a version of PAKCS that matches one of the overlay files, as it reduces the time required to run tests from several hours to just a few minutes. Applying the overlay avoids having to compile hundreds of test modules to ICurry.

scripts/

setup-dev-machine.sh, the script that sets up a machine for work on Sprite; see Developer Setup.

spritelog.vim

A Vim syntax-highlighting file to aid in the analysis of Sprite debug output. Consider installing this if you plan to look at computation traces generated by Sprite.

TODO, NOTES

The dated work logs of the project. An entry records what changed, what was measured, and what is left; the claims of an older entry can be out of date, so the code wins over them.

src/

The Sprite source code.

export/: Files exported to the installation directory.
python/: The Python code implementing Sprite.
cyrt/: Source code of the Sprite runtime libraries.

tests/

The test suite. See tests/README for help running tests.

data/: The test data. This includes Curry source files, text (data) files, and expected results.
func_*.py: Functional tests. These execute whole Curry programs and check their output against another Curry system.
lib/: Test support code. The cytest subdirectory contains useful extensions to Python’s unittest module for testing Curry programs.
oracle*: Driver scripts for Curry oracles. An oracle is a Curry system such as PAKCS or KiCS2 that generates the expected output a Curry program. Functional tests validate Sprite by comparing its output to that of an oracle.
run_tests: The test driver. Used to run tests.
unit_*.py: Unit tests. These test isolated components of Sprite.