Skip to content

Home

Jump to bottom Edit New page
Thierry Fredrich edited this page Mar 25, 2021 · 3 revisions

Tested on Ubuntu 16.04

How to get this code?

Change the directory within that your code will be synchronized.

cd /where/the/source/should/be

execute

git clone https://github.com/thierry3000/VBL

A directory called VBL will be created inside /where/the/source/should/be. Change into that directory and list the available branches.

cd /where/the/source/should/be/VBL

git branch -a

checkout your preferred branch. eg.

git checkout develop

How to build this code?

We support the cmake build system. Change the directory to the folder where the build should be created!

cd /where/the/build/should/be/build

Execute cmake and provide the path to the source.

cmake /where/the/source/should/be

A Makefile should be present now. Note: ccmake is nice graphic tool to change settings of the build. We use it to change the installation directory. Type

ccmake .

This assumes that you current directory is still the build directory.

  • Move to CMAKE_INSTALL_PREFIX and hit enter.
  • Change you value to /my/install/directory
  • Hit enter to copy.
  • Hit c to configure.
  • Hit e to exit help.
  • Hit g to generate the new modified Makefile (with your new install diretory)

Type

make install

This will hopefully build and install your copy of VBL. Please also have a look into the subfolder install_helpers to find more predefined configurations (ubuntu 18).

How to use this code?

After the preceding step an executable called vbl-v3.2 should be present in the directory: /my/install/directory/bin In case the install directory is no default system path (like /usr/ or /usr/local) we have to add the path to the vbl library to the linker.

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/my/install/directory/lib

Lets create a directory for the simulation output.

mkdir /my/output/dir

and change the directory to it

cd /my/output/dir

First, we need to create an additional folder where vbl will place its dump file. By convention this folder is called runs. So we create it.

mkdir runs

Now we need to provide the VBL parameters. We do so by copying the default form the repository. Of course this could be change to your personal needs.

cp /where/the/source/should/be/VBL/parameters/* .

Finally you can invoke the executable by

/my/install/directory/bin/vbl-v3.2 c -2

c means command from file and -2 is just an leftover form previous implementations (should be remove in future!)

Add a custom footer
Add a custom sidebar
Clone this wiki locally