Edit on GitHub

Installation

Prerequisites

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

Installing LogicCircuits

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("LogicCircuits")'

To install the package with the latest commits on master branch, run:

julia -e 'using Pkg; Pkg.add(PackageSpec(url="https://github.com/Tractables/LogicCircuits.jl.git"))'

From Julia Pkg REPL

Note

To get to Pkg mode, you need to run julia, then to press ]. Press backspace or ^C to get back to normal REPL mode.

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

add LogicCircuits

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

add LogicCircuits#master

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("LogicCircuits")'

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