Getting Started

In this section you will get a quick start into VAMPzero. The following pages will lead you through the complete process for downloading, installing and running VAMPzero.

Download

There are currently two versions of VAMPzero available. The first one is a python wheel, the second one is the direct source code. If you just want to use it you can start by installing the python wheel.

If you are interested in looking at the code, including your own equations and factors, the plain source code is probably right for you.

Dependencies

VAMPzero depends on a bunch of other modules. The Python dependencies should be loaded and installed automatically during the installation process. The C libraries TIXI and TIGL need to be installed manually. You can download binary packages for both libraries from GitHub. The following links point to the TIXI and TIGL download pages.

If you add the libraries to you standard system path VAMPzero should be able to find them. If not, please provide the path to the libraries through the configuration file.

Python Wheel

The easiest way to get started with VAMPzero is by installing the Python wheel. You can install it using pip:

pip install PATH/TO/WHEEL

Source Code

Currently, VAMPzero is provided as a scripted version. So you should be familiar at least to some extend to Python programming. VAMPzero runs on Python 2.7 so this should be installed on your computer along with the setuptools. The installer will load missing packages.

Now open a console and browse to the folder where you have unzipped VAMPzero. Type:

python setup.py install

VAMPzero will now register itself with your Python distribution. For a simple start you can try to run the delivered script:

python VAMPzero.py

Output

In the commandline prompt you will see the calculation running. VAMPzero displays all values read, the calculation history for each iteration and will finally print a list of all calculated results. The last lines in the output window should read something like:

##############################################################################
                                VAMPzero
                                FINISHED
                           15.06 seconds passed
##############################################################################
##############################################################################

If you can read this message there is a good chance that your first calculation run was successful. For more information on the calculation run you can look into The Log File . You can now proceed to one of the following sections. There is information on handling the results generated by VAMPzero as well as some more information on how to manipulate the input data.