Installation

Build prerequisites

SCAN is entirely written in Rust, so, to build it, you need to install a recent version of the Rust toolchain. The easiest and recommended way to do so is by installing rustup either following the instructions on its homepage or through your OS’s package manager. Do not forget to set your PATH correctly, if required.

Installing with Cargo

To install and use SCAN on your system, the easiest way is to use the cargo install command, with:

cargo install smc_scan --locked

Cargo will build and install SCAN on your system (the --locked option is not required, but it is recommended as it improves build reproducibility by enforcing the use of specified versions for dependencies).

Cargo will build and install SCAN on your system, after which it can be used as a command-line tool. The same command updates SCAN to the latest version.

After installation, type

scan

to verify that the installation completed successfully by displaying the in-line help.