aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 27 insertions, 12 deletions
diff --git a/README.md b/README.md
index c6b3690..4ddbe66 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ pruning table. If so, about 200Mb should be enough.
31### On Windows 31### On Windows
32 32
33Try downloading and executing in a terminal the file nissy.exe, then 33Try downloading and executing in a terminal the file nissy.exe, then
34follow the instructions in the UNIX section below for downloading and 34follow the instructions in the **Tables** section below for
35installing the pruning tables. 35installing the pruning tables.
36If nissy.exe does not work, you can try following the UNIX instructions 36If nissy.exe does not work, you can try following the UNIX instructions
37in WSL (Windows Subsystem for Linux) or in a similar environment. 37in WSL (Windows Subsystem for Linux) or in a similar environment.
@@ -40,17 +40,32 @@ Sorry for the inconvenience, I don't have a Windows machine to test this on.
40 40
41### On a UNIX system: 41### On a UNIX system:
42 42
43You can download the source code for the latest version from git or simply clone
44the repo with `git clone https://github.com/sebastianotronto/nissy`.
45
46Edit the Makefile to match your local configuration (usually not necessary, but you 43Edit the Makefile to match your local configuration (usually not necessary, but you
47may want to change the `PREFIX` variable) and run `make`, followed by `make install`. 44may want to change the `PREFIX` variable) and run `make`, followed by `make install`.
48After that, you need to download some files and manually save them to your `NISSYDATA` 45Follows the instructions below to install the pruning tables.
49folder (see manual page, ENVIRONMENT section). If you don't do it nissy can compute 46
50these files when needed and save them in the correct folders, but some of them 47### Tables
51take hours to generate even for a powerful computer (for reference, the huge pruning 48Nissy needs to generate certain large tables to work. These tables are by default
52table takes about 20 hours on my laptop). 49generated the first time they are needed (e.g the first time you ask to solve a
50certain step) and then saved to a file. The following times nissy simply loads the
51corresponding file from the hard disk.
52
53The very large table for optimal solving can take some time to generate (about 20
54minutes on my fairly old but decent laptop, using 8 CPU threads). All other
55tables are much faster.
56
57You can ask nissy to generate all the tables it will ever need with the **gen**
58command. It is recommended to use more than one thread, if your CPU has them.
59For example, you can run:
60
61```
62nissy gen -t 8
63```
64
65to generate all tables using 8 threads.
53 66
67Alternatively, you can simply download all the tables and copy them into the
68correct folder (see manual page, `ENVIRONMENT` section).
54Choose one of the following: 69Choose one of the following:
55 70
56| |.zip|.tar.gz| 71| |.zip|.tar.gz|
@@ -58,9 +73,9 @@ Choose one of the following:
58|Full (~720Mb)|[full.zip](https://math.uni.lu/tronto/nissy/nissy-tables-full.zip)|[full.tar.gz](https://math.uni.lu/tronto/nissy/nissy-tables-full.tar.gz)| 73|Full (~720Mb)|[full.zip](https://math.uni.lu/tronto/nissy/nissy-tables-full.zip)|[full.tar.gz](https://math.uni.lu/tronto/nissy/nissy-tables-full.tar.gz)|
59|No huge table (~90Mb)|[nohuge.zip](https://math.uni.lu/tronto/nissy/nissy-tables-nohuge.zip)|[nohuge.tar.gz](https://math.uni.lu/tronto/nissy/nissy-tables-nohuge.tar.gz)| 74|No huge table (~90Mb)|[nohuge.zip](https://math.uni.lu/tronto/nissy/nissy-tables-nohuge.zip)|[nohuge.tar.gz](https://math.uni.lu/tronto/nissy/nissy-tables-nohuge.tar.gz)|
60 75
61extract the archive and copy the `tables` folder into `NISSIDATA` (paste there 76extract the archive and copy the tables folder into `NISSIDATA` (paste there
62the whole folder, not the single files). The `nohuge` files are much smaller and 77the whole folder, not file by file). The "nohuge" files are much smaller and do not
63do not contain the huge pruning table for the optimal solver. 78contain the huge pruning table for the optimal solver.
64 79
65## Structure of the code 80## Structure of the code
66 81

Generated with cgit - Back to sebastiano.tronto.net