Installation

Prerequisites

Julia 1.5 or greater. For installation, please refer to the official Julia Website.

Installing ProbabilisticCircuits

You can use Julia's package manager, Pkg, to install this module and its dependencies. There are different options on how to do that, for example through command line or julia REPL. For more information and options on how to use Julia pacakge manager, please refer to Pkg's Documentation.

From Command Line

To install the latest stable release, run:

julia -e 'using Pkg; Pkg.add("ProbabilisticCircuits")'

You can also install the package with the latest commits on master branch. In that case, its also recommented to install the latest LogicCircuits:

julia -e 'using Pkg; Pkg.add([PackageSpec(url="https://github.com/Juice-jl/LogicCircuits.jl.git"),PackageSpec(url="https://github.com/Juice-jl/ProbabilisticCircuits.jl.git")])'

While in Pkg mode, run the following to install the latest release:

add ProbabilisticCircuits

Similarly, to install from the latest commits on master branch, run:

add LogicCircuits#master
add ProbabilisticCircuits#master

Optional Dependencies

We use Requires.jl to make some of our rarely used dependencies optional, so they do not automatically get installed. Currently, BlossomV.jl is the only such dependency due to its rare ussage and issues with Windows. This means if you get an error related to BlossomV.jl, you can fix that by adding BlossomV to your project using Pkg.add.

Testing

If you are installing the latest commit, we recommend running the test suite to make sure everything is in order, to do that run:

julia --color=yes -e 'using Pkg; Pkg.test("ProbabilisticCircuits")'

Note: If you want the tests to run faster, you can use multiple cores. To do that set the following environment variable (default = 1 core):

export JIVE_PROCS=8