| commit | author | age | ||
| ac9fa6 | 1 | TRISURF NG |
| SP | 2 | ========== |
| 3 | ||
| 4 | ||
| 5 | 1. Instalation | |
| 6 | -------------- | |
| 7 | ||
| 58fd63 | 8 | To compile the program, user must have ``automake``, and ``gcc`` tools installed on the computer. |
| ac9fa6 | 9 | |
| 08d2f8 | 10 | Required C libraries are: |
| ac9fa6 | 11 | * libconfuse |
| SP | 12 | * libgsl |
| 13 | * libxml2 | |
| 720bd4 | 14 | * zlib |
| ac9fa6 | 15 | |
| 08d2f8 | 16 | and python libraries for running tsmgr: |
| SP | 17 | * tabulate |
| 18 | * psutil | |
| 19 | * configobj | |
| 20 | ||
| ac9fa6 | 21 | On Debian based systems, install prerequisities by typing the following command in the command line: |
| SP | 22 | |
| 08d2f8 | 23 | ``sudo apt-get install libconfuse-dev libgsl0-dev libxml2-dev zlib1g-dev automake gcc python3-psutil python3 python3-pip`` |
| SP | 24 | ``sudo pip3 install tabulate configobj`` |
| ac9fa6 | 25 | |
| SP | 26 | Move to the project root directory and compile with: |
| 27 | ||
| 58fd63 | 28 | ``./configure`` |
| 9a658d | 29 | |
| 58fd63 | 30 | ``make`` |
| 9a658d | 31 | |
| 58fd63 | 32 | ``make install`` |
| ac9fa6 | 33 | |
| SP | 34 | If you are experiencing difficulties due to different automake versions, proceed with the longer procedure: |
| 35 | ||
| 58fd63 | 36 | ``aclocal`` |
| 9a658d | 37 | |
| 58fd63 | 38 | ``autoheader`` |
| 9a658d | 39 | |
| 58fd63 | 40 | ``automake -ac`` |
| 9a658d | 41 | |
| 58fd63 | 42 | ``autoconf`` |
| 9a658d | 43 | |
| 58fd63 | 44 | ``./configure`` |
| 9a658d | 45 | |
| 58fd63 | 46 | ``make`` |
| 9a658d | 47 | |
| 58fd63 | 48 | ``make install`` |
| ac9fa6 | 49 | |
| SP | 50 | |
| d84529 | 51 | This procedure can be done automatically by calling the build.sh script. |
| SP | 52 | |
| ac9fa6 | 53 | 2. Use |
| SP | 54 | ------ |
| 55 | ||
| 58fd63 | 56 | Prepare tape file, storing the definition for the simulation. You can use the sample tape file in the ``src/`` directory as a template for your simulation. |
| ac9fa6 | 57 | |
| 58fd63 | 58 | Run simulations with ``trisurf-ng --force-from-tape`` for initial run, or ``trisurf-ng`` for continuing aborted simulations. |
| ac9fa6 | 59 | |
| SP | 60 | |
