aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL93
1 files changed, 57 insertions, 36 deletions
diff --git a/INSTALL b/INSTALL
index f0bba55..ffc461d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,57 +4,78 @@ Nissy is available at https://nissy.tronto.net
4 4
5# Requirements 5# Requirements
6 6
7A full installation of nissy requires about 3Gb of space, 7A full installation of nissy requires about 3Gb of space, of which
8of which 2.3Gb are occupied by the huge pruning table for fast optimal solving, 82.3Gb are occupied by the huge pruning table for fast optimal solving,
9and running it requires the same amount of RAM. 9and running it requires the same amount of RAM. One can choose to never
10One can choose to never use this function and not to install the relative 10use this function and not to install the relative pruning table. There
11pruning table. There is an alternative (slower) 11is an alternative (slower) optimal solving function that uses about
12optimal solving function that uses about 500Mb of RAM. 12500Mb of RAM. When generating the pruning tables automatically (see
13the section Tables below), at least 5.3Gb or RAM are required.
13 14
14# Installation 15# Installation
15 16
16## On Windows 17## On Windows
17 18
18Try downloading and executing in a terminal the file nissy.exe, then 19Try downloading and executing in a terminal the file nissy.exe, then
19follow the instructions in the Tables section below for 20follow the instructions in the Tables section below for installing the
20installing the pruning tables. 21pruning tables. If nissy.exe does not work, you can try following the
21If nissy.exe does not work, you can try following the UNIX instructions 22UNIX instructions in WSL (Windows Subsystem for Linux) or in a similar
22in WSL (Windows Subsystem for Linux) or in a similar environment. 23environment.
23
24Sorry for the inconvenience, I don't have a Windows machine to test this on.
25 24
26## On a UNIX system: 25## On a UNIX system:
27 26
28Edit the Makefile to match your local configuration (usually not necessary, but you 27Download the source archive (.tar.gz). Extract it with your favorite
29may want to change the PREFIX variable) and run make, followed by make install. 28archive program, for example with
30Follow the instructions below to install the pruning tables. 29
30 tar -xvzf nissy-VERSION.tar.gz
31
32Open a terminal in the directory just extracted. If you wish, edit the
33Makefile to match your local configuration (this is usually not necessary,
34but you may want to change the PREFIX variable to change the installation
35path) and run
36
37 make
38
39followed by
40
41 make install
42
43Then follow the instructions below to install the pruning tables.
31 44
32## Tables 45## Tables
33Nissy needs to generate certain large tables to work. These tables are by default
34generated the first time they are needed (e.g the first time you ask to solve a
35certain step) and then saved to a file. Whenever these tables are needed again,
36nissy simply loads the corresponding file from the hard disk.
37 46
38The very large table for optimal solving can take some time to generate 47Once you have installed nissy, run
39(about 1.5 hours on my fairly old but decent laptop, using 8 CPU threads).
40In order to generate it you need at least 5Gb of RAM.
41All other tables are much faster.
42 48
43You can ask nissy to generate all the tables it will ever need with the gen 49 nissy gen
44command. It is recommended to use more than one thread, if your CPU has them.
45For example, you can run:
46 50
47nissy gen -t 8 51to generate all the tables that Nissy will ever need. Running this
52command requires around 5.3Gb of RAM, and it can take some time (about
5340 minutes on my fairly old but decent laptop, with 8 CPU threads).
48 54
49to generate all tables using 8 threads. 55Some unnecessary technical detail: by default this command is going to
56use at most 64 threads. If you want you can choose to use more threads
57(if your CPU is very powerful) or fewer threads (if you for example
58want to run this command in the background while you do other stuff)
59with the -t option, for example nissy gen -t 1.
50 60
51Alternatively, you can simply download all the tables and copy them into the 61Alternatively, you can download all the tables (1.7Gb) and copy them
52correct folder (see manual page, ENVIRONMENT section). On UNIX operating 62into the correct folder (see manual page, ENVIRONMENT section). On UNIX
53systems this folder is either .nissy/tables in the user's home directory or 63operating systems this folder is either .nissy/tables in the user's
54$XDG_DATA_HOME/nissy/tables if the XDG variable is configured. On Windows 64home directory or $XDG_DATA_HOME/nissy/tables if the XDG variable
55it is the same directory as the nissy.exe executable file. 65is configured. On Windows it is the same directory as the nissy.exe
66executable file.
56 67
57You can downloads all the tables from the following link: 68You can downloads all the tables from the following link:
58 https://nissy.tronto.net/nissy-tables-2.0.zip 69
59The version 2.0 at the end of the file name is only indicative. 70 https://nissy.tronto.net/nissy-tables-2.0.2.zip
60Later versions will use the same tables, unless otherwise specified. 71
72# Upgrading
73
74If you already have nissy installed and you want to upgrade to a more
75recent version, you can simply repeat the installation process:
76* On Windows: simply replace nissy.exe with the new file with the same name.
77* On UNIX systems: download the new version of the source code, extract it
78 in a new folder and run make and make install again.
79
80Between each version new table files might have been added, or old ones
81may be not used anymore. Nissy will deal with this automatically.

Generated with cgit - Back to sebastiano.tronto.net