Install

WARNING

OptiFloat.jl currently requires Julia 1.11 and Metatheory.jl 3.0.

To install OptiFloat.jl, start julia, enter the package REPL via ] and type:

pkg> add https://github.com/nmheim/OptiFloat.jl

Develop

To work on OptiFloat.jl itself, install the package in development mode:

pkg> dev https://github.com/nmheim/OptiFloat.jl

This should make the source code available in ~/.julia/dev/OptiFloat. You can start julia in the OptiFloat environment with julia --project=~/.julia/dev/OptiFloat, and type ]test to run the tests.

Building Documentation

The documentation of OptiFloat is built with DocumenterVitepress.jl. To build the docs, start a julia REPL in the docs environment and run docs/make.jl:

julia> include("docs/make.jl")

In a second terminal in the docs directory, run:

$ npm run docs:dev