Guides

Step-by-step pages for running goldsluice and for writing an algorithm.

• Batch mode: define a dataset, process it, read it back
• Running goldsluice and developing an algorithm

Running goldsluice

• Batch mode: define a dataset, process it, read it back: the dataset definition file, check and run, reading the result with goldpan.

• Running goldsluice and developing an algorithm: setup (Rust), running and timing, and the path of a new algorithm from the Python mirror to the Rust kernel.

Writing an algorithm

• PORTING.md: the rules the Python mirror must follow so that the port is mechanical, a table of the equivalent Python and Rust, and a checklist.

Writing an adapter for goldpan

• Writing an adapter, in the goldpan documentation: so that goldpan reads another file format, which batch mode then uses.

Working on goldsluice

• CONTRIBUTING.md: Git Flow, building with maturin, tests, releases. AGENTS.md has the rules for AI coding agents.

• The changelog.

• Student guides and notes of the NSDF-Data project.