aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL81
1 files changed, 0 insertions, 81 deletions
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index ffc461d..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,81 +0,0 @@
1# Website
2
3Nissy is available at https://nissy.tronto.net
4
5# Requirements
6
7A full installation of nissy requires about 3Gb of space, of which
82.3Gb are occupied by the huge pruning table for fast optimal solving,
9and running it requires the same amount of RAM. One can choose to never
10use this function and not to install the relative pruning table. There
11is an alternative (slower) optimal solving function that uses about
12500Mb of RAM. When generating the pruning tables automatically (see
13the section Tables below), at least 5.3Gb or RAM are required.
14
15# Installation
16
17## On Windows
18
19Try downloading and executing in a terminal the file nissy.exe, then
20follow the instructions in the Tables section below for installing the
21pruning tables. If nissy.exe does not work, you can try following the
22UNIX instructions in WSL (Windows Subsystem for Linux) or in a similar
23environment.
24
25## On a UNIX system:
26
27Download the source archive (.tar.gz). Extract it with your favorite
28archive program, for example with
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.
44
45## Tables
46
47Once you have installed nissy, run
48
49 nissy gen
50
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).
54
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.
60
61Alternatively, you can download all the tables (1.7Gb) and copy them
62into the correct folder (see manual page, ENVIRONMENT section). On UNIX
63operating systems this folder is either .nissy/tables in the user's
64home directory or $XDG_DATA_HOME/nissy/tables if the XDG variable
65is configured. On Windows it is the same directory as the nissy.exe
66executable file.
67
68You can downloads all the tables from the following link:
69
70 https://nissy.tronto.net/nissy-tables-2.0.2.zip
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