Installation

To use this project, you need to have an installation of Rust. Since we are using flint-sys which itself uses gmp, we are currently restricted to usage on Mac, Linux and Linux subsystems under Windows. For a subsystem under Windows, you are additionally required to have installed m4 and a C-compiler like gcc. Furthermore, make sure to have make installed.

Command for installing m4, gcc, and make:

sudo apt-get install m4 gcc make

Integration

You can integrate our libraries via crates.io (not supported yet, as we have not published it here yet) or you can get the latest version directly from GitHub. To get the latest version from GitHub, you can include a link to the dev branch in your Cargo.toml.

qfall-math = { git = "https://github.com/qfall/math", branch="dev" }
qfall-schemes = { git = "https://github.com/qfall/schemes", branch="dev" }
qfall-tools = { git = "https://github.com/qfall/tools", branch="dev" }

Be aware that the external libraries in our projects have to be compiled at the first installation, which may take about 10-30 minutes (depending on the used hardware and operating system). After the first installation, it should be working fine.

Documentation

You can find our documentations on crates.io (not supported yet, as we have not published it here yet) or you can build the latest documentation locally. Once you have integrated the desired library, you can build the project and open the documentation of the entire project. This includes our libraries for which you can then check the respective documentation.

cargo build
cargo doc --open

If you’re using WSL and your browser does not open, retry after installing wslu (this helped for us).

What can you expect from our documentation? Every public interface is provided with (1) an explanation of the behavior; (2) a description of all parameters; (3) a description of the output; (4) an example of the function; and (5) a description of potential errors and failures that can occur.