--- a/README.md Fri May 15 14:40:02 2026 -0500 +++ b/README.md Sun Jul 19 07:34:39 2026 +0200 @@ -27,14 +27,14 @@ 1. Install the [Rust] infrastructure (including Cargo) with [rustup]. 2. Install a “nightly” release of the Rust compiler. With rustup, installed in the previous step, this can be done with - ```console - rustup toolchain install nightly - ``` + + rustup toolchain install nightly + 3. Install [GNU Scientific Library]. On a Mac with [Homebrew] installed, this can be done with - ```console - brew install gsl - ``` + + brew install gsl + For other operating systems, suggestions are available in the [rust-GSL] crate documentation. If not correctly installed, you may need to pass extra `RUSTFLAGS` options to Cargo in the following steps to locate the @@ -56,21 +56,21 @@ ### Building and running the experiments To compile and install the program, use -```console -cargo install --path=. -``` + + cargo install --path=. + When doing this for the first time, several dependencies will be downloaded. Now you can run the default set of experiments with -``` -pointsource_experiments -o results -``` + + pointsource_experiments -o results --max-iter 4000 1d_fast 2d_fast 1d_tv_fast 2d_tv_fast + The `-o results` option tells `pointsource_algs` to write results in the `results` directory. The option is required. Alternatively, you may build and run the program without installing with -```console -cargo run --release -- -o results -``` + + cargo run --release -- -o results --maxiter 4000 1d_fast 2d_fast 1d_tv_fast 2d_tv_fast + The double-dash separates the options for the Cargo build system and `pointsource_experiments`. @@ -83,10 +83,10 @@ If you are interested in the program internals, the integrated source code documentation may be built and opened with -```console -cargo doc # build dependency docs -misc/cargo-d --open # build and open KaTeX-aware docs for this crate -``` + + cargo doc # build dependency docs + misc/cargo-d --open # build and open KaTeX-aware docs for this crate + The `cargo-d` script ensures that KaTeX mathematics is rendered in the generated documentation through an ugly workaround. Unfortunately, `rustdoc`, akin to Rust largely itself, is stuck in 80's 7-bit gringo ASCII