aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSebastiano Tronto <sebastiano.tronto@gmail.com>2021-12-27 16:34:41 +0100
committerSebastiano Tronto <sebastiano.tronto@gmail.com>2021-12-27 16:34:41 +0100
commit9f3c7e7ea5d872fc017271df61691ea545049211 (patch)
treeeccc6b3a1fd6640728e3c871addb4850522e24f0 /README.md
parent2332679ad64e3e0318ca812421190156edec9186 (diff)
downloadnissy-9f3c7e7ea5d872fc017271df61691ea545049211.tar.gz
nissy-9f3c7e7ea5d872fc017271df61691ea545049211.zip
Changed installation instructions (for pruning tables)
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 19 insertions, 25 deletions
diff --git a/README.md b/README.md
index eac348c..6166852 100644
--- a/README.md
+++ b/README.md
@@ -21,17 +21,11 @@ solutions for EO/DR/HTR or similar substeps.
21 21
22## Requirements 22## Requirements
23 23
24** Warning: ** *This section is not up to date with the code. In nissy-2.0beta8 24A full installation of nissy requires about 3Gb of space,
25or later the only way to get the table files is to generate them yourself. 25of which 2.3Gb are occupied by the huge pruning table for fast optimal solving,
26All but the huge table just requires a few minutes; the huge table for
27optimal solving can require a couple of hours. Use more than 1 thread
28if you can.*
29
30A full installation of Nissy requires a little more than 2Gb of space,
31of which 1.6Gb are occupied by the huge pruning table for fast optimal solving,
32and running it requires the same amount of RAM. 26and running it requires the same amount of RAM.
33One can choose to never use this function and not to install the relative 27One can choose to never use this function and not to install the relative
34pruning table. There is an alternative (about 5 times slower) 28pruning table. There is an alternative (slower)
35optimal solving function that uses about 500Mb of RAM. 29optimal solving function that uses about 500Mb of RAM.
36 30
37## Installation 31## Installation
@@ -55,14 +49,14 @@ Follows the instructions below to install the pruning tables.
55### Tables 49### Tables
56Nissy needs to generate certain large tables to work. These tables are by default 50Nissy needs to generate certain large tables to work. These tables are by default
57generated the first time they are needed (e.g the first time you ask to solve a 51generated the first time they are needed (e.g the first time you ask to solve a
58certain step) and then saved to a file. The following times Nissy simply loads the 52certain step) and then saved to a file. Whenever these tables are needed again,
59corresponding file from the hard disk. 53nissy simply loads the corresponding file from the hard disk.
60 54
61The very large table for optimal solving can take some time to generate (about 20 55The very large table for optimal solving can take some time to generate
62minutes on my fairly old but decent laptop, using 8 CPU threads). All other 56(about 1.5 hours on my fairly old but decent laptop, using 8 CPU threads).
63tables are much faster. 57All other tables are much faster.
64 58
65You can ask Nissy to generate all the tables it will ever need with the **gen** 59You can ask Nissy to generate all the tables it will ever need with the `gen`
66command. It is recommended to use more than one thread, if your CPU has them. 60command. It is recommended to use more than one thread, if your CPU has them.
67For example, you can run: 61For example, you can run:
68 62
@@ -73,17 +67,17 @@ nissy gen -t 8
73to generate all tables using 8 threads. 67to generate all tables using 8 threads.
74 68
75Alternatively, you can simply download all the tables and copy them into the 69Alternatively, you can simply download all the tables and copy them into the
76correct folder (see manual page, `ENVIRONMENT` section). 70correct folder (see manual page, `ENVIRONMENT` section). On UNIX operating
77Choose one of the following: 71systems this folder is either `.nissy/tables` in the user's home directory or
78 72`$XDG_DATA_HOME/nissy/tables` if the XDG variable is configured. On Windows
79| |.zip|.tar.gz| 73it is the same directory as the nissy.exe executable file.
80|-|-|-|
81|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)|
82|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)|
83 74
84extract the archive and copy the tables folder into `NISSIDATA` (paste there 75Choose either the
85the whole folder, not file by file). The "nohuge" files are much smaller and do not 76[zip](https://math.uni.lu/tronto/nissy/nissy-tables-2.0.zip)
86contain the huge pruning table for the optimal solver. 77or the
78[tar.gz](https://math.uni.lu/tronto/nissy/nissy-tables-2.0.tar.gz)
79file (click the links to download) and
80extract them in the correct folder.
87 81
88## Structure of the code 82## Structure of the code
89 83

Generated with cgit - Back to sebastiano.tronto.net