This repository uses a Julia workspace for reproducibility — see Julia Workspace Layout in the Copilot instructions for the full member/environment breakdown.

Setup

1. Clone this repository.

2. Instantiate the root environment (library + its production dependencies):

julia --project=. -e 'using Pkg; Pkg.instantiate()'

3. Run the tests (uses the test/ workspace member environment):

julia --project=. -e 'using Pkg; Pkg.test()'

4. Build the documentation locally (uses the docs/ workspace member environment):

julia --project=docs docs/make.jl

The built site is in docs/build/ — open docs/build/index.html in a browser.

Notebook Setup

notebooks/ is not a workspace member, so <!-- TODO: RepoName --> is not auto-resolved there. After cloning (or after removing notebooks/Manifest.toml), run once in the notebooks directory:

julia --project=./notebooks

Then in the REPL Pkg mode (press ]):

pkg> dev ..
pkg> instantiate

This creates notebooks/Manifest.toml (gitignored) with path = ".." pointing at the root package. Subsequent julia --project=./notebooks invocations will resolve <!-- TODO: RepoName --> from the local source.

Documentation

Documentation is deployed cross-repo to the Math & Tech Study Hub:

https://study.fourm.info//dev/