INSTALLING

   1 Matilda is presently run as standalone executables, with no installation
   2 required or supported. It is currently aimed at Linux, BSD and macOS systems.
   3 If you have difficulties compiling Matilda for these systems please open an
   4 issue at GitHub.
   5
   6
   7 PREPARATION
   8
   9 It is tested using GCC and Clang. Please try to use modern versions of these
  10 compilers. They need to be recent enough to support OpenMP 3.0.
  11
  12 On macOS do not use the default Xcode clang -- it does not support OpenMP.
  13 Instead install through brew clang-omp, and override the compiler to be used
  14 in src/Makefile.
  15
  16 Before compiling, review the contents of the file src/inc/config.h for your
  17 system. Remember to edit the line
  18
  19 #define UCT_MEMORY 512
  20
  21 with the amount of memory (in MiB) that Matilda can use for MCTS. Please notice
  22 Matilda is agressive in its use of the available memory: It will cache game
  23 state information instead of freeing it, so do not be surprised to see the
  24 memory used always go up.
  25
  26 Other settings may also be configured for a widely different setting than your
  27 own, so please try to take a look at the options meant for editing.
  28
  29
  30 COMPILATION
  31
  32 When ready, execute
  33
  34 make
  35
  36 You should now have an executable file named matilda, that is the main program.
  37
  38 To test the good behaviour of the program in the current system you can also run
  39 the executable named test.
  40
  41 For short instructions on how to use each program run them with --help.
  42
  43 All external files reside in the folder data/. Files produced by Matilda will
  44 also be produced to this folder only.
  45
  46 Matilda will expect to find the data/ folder in the current working directory,
  47 that by default is that of the parent process. Because of this, you may need to
  48 create a link to data/ in the current directory, or use the switch --data
  49 <folder> to override the directory path.