Installation

Installation from Sources

To install Liquidity from sources, you will need a working installation of OCaml with OPAM at least version 2.0.

As of Aug 15, 2018, the following process should work:

  1. Create an OPAM switch called liquidity, with version 4.06.1 of OCaml:

    opam switch create liquidity 4.06.1
    

This command should take some time to compile the OCaml distribution. Everytime you want to use this switch in a terminal, you should use the following command:

eval `opam env --switch liquidity`
  1. Checkout the Github repository:

    git clone https://github.com/OCamlPro/liquidity
    cd liquidity
    
This command should create a liquidity directory with the next branch.
  1. Within the liquidity directory, the Tezos sources in branch mainnet should be in a subdirectory tezos. This can be achieved either with a symbolic link, or by checkouting the sources:

    make clone-tezos
    
  2. Install Liquidity dependencies:

    make build-deps
    
  3. Build and install:

    make
    make install
    
The last command should install the command liquidity in the OPAM switch liquidity.
  1. Do a simple test:

    (cd tests && liquidity test0.liq)
    
  2. Optionnally, you can build some local documentation with sphinx and the Read-The-Docs theme (pip3 install sphinx-rtd-theme):

    make doc
    

    The documentation should then be available in docs/sphinx/Liquidity.pdf, docs/sphinx/Liquidity.epub and in the docs/sphinx/_site/ sub-directory for HTML.