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