diff options
| -rw-r--r-- | INSTALL | 35 | ||||
| -rw-r--r-- | README.md | 44 | ||||
| -rw-r--r-- | TODO.md | 6 |
3 files changed, 39 insertions, 46 deletions
| @@ -1,10 +1,10 @@ | |||
| 1 | # Requirements | 1 | # Requirements |
| 2 | 2 | ||
| 3 | A full installation of nissy requires a little more than 2Gb of space, | 3 | A full installation of nissy requires about 3Gb of space, |
| 4 | of which 1.6Gb are occupied by the huge pruning table for fast optimal solving, | 4 | of which 2.3Gb are occupied by the huge pruning table for fast optimal solving, |
| 5 | and running it requires the same amount of RAM. | 5 | and running it requires the same amount of RAM. |
| 6 | One can choose to never use this function and not to install the relative | 6 | One can choose to never use this function and not to install the relative |
| 7 | pruning table. There is an alternative (about 5 times slower) | 7 | pruning table. There is an alternative (slower) |
| 8 | optimal solving function that uses about 500Mb of RAM. | 8 | optimal solving function that uses about 500Mb of RAM. |
| 9 | 9 | ||
| 10 | # Installation | 10 | # Installation |
| @@ -28,12 +28,12 @@ Follows the instructions below to install the pruning tables. | |||
| 28 | ## Tables | 28 | ## Tables |
| 29 | Nissy needs to generate certain large tables to work. These tables are by default | 29 | Nissy needs to generate certain large tables to work. These tables are by default |
| 30 | generated the first time they are needed (e.g the first time you ask to solve a | 30 | generated the first time they are needed (e.g the first time you ask to solve a |
| 31 | certain step) and then saved to a file. The following times nissy simply loads the | 31 | certain step) and then saved to a file. Whenever these tables are needed again, |
| 32 | corresponding file from the hard disk. | 32 | nissy simply loads the corresponding file from the hard disk. |
| 33 | 33 | ||
| 34 | The very large table for optimal solving can take some time to generate (about 20 | 34 | The very large table for optimal solving can take some time to generate |
| 35 | minutes on my fairly old but decent laptop, using 8 CPU threads). All other | 35 | (about 1.5 hours on my fairly old but decent laptop, using 8 CPU threads). |
| 36 | tables are much faster. | 36 | All other tables are much faster. |
| 37 | 37 | ||
| 38 | You can ask nissy to generate all the tables it will ever need with the gen | 38 | You can ask nissy to generate all the tables it will ever need with the gen |
| 39 | command. It is recommended to use more than one thread, if your CPU has them. | 39 | command. It is recommended to use more than one thread, if your CPU has them. |
| @@ -44,12 +44,13 @@ nissy gen -t 8 | |||
| 44 | to generate all tables using 8 threads. | 44 | to generate all tables using 8 threads. |
| 45 | 45 | ||
| 46 | Alternatively, you can simply download all the tables and copy them into the | 46 | Alternatively, you can simply download all the tables and copy them into the |
| 47 | correct folder (see manual page, ENVIRONMENT section). | 47 | correct folder (see manual page, ENVIRONMENT section). On UNIX operating |
| 48 | Choose one of the following: | 48 | systems this folder is either .nissy/tables in the user's home directory or |
| 49 | https://math.uni.lu/tronto/nissy/nissy-tables-full.zip | 49 | $XDG_DATA_HOME/nissy/tables if the XDG variable is configured. On Windows |
| 50 | https://math.uni.lu/tronto/nissy/nissy-tables-full.tar.gz | 50 | it is the same directory as the nissy.exe executable file. |
| 51 | https://math.uni.lu/tronto/nissy/nissy-tables-nohuge.zip | 51 | |
| 52 | https://math.uni.lu/tronto/nissy/nissy-tables-nohuge.tar.gz | 52 | Choose either (zip format) |
| 53 | extract the archive and copy the tables folder into NISSIDATA (paste there | 53 | https://math.uni.lu/tronto/nissy/nissy-tables-2.0.zip |
| 54 | the whole folder, not file by file). The "nohuge" files are much smaller and do not | 54 | or (tar.gz format) |
| 55 | contain the huge pruning table for the optimal solver. | 55 | https://math.uni.lu/tronto/nissy/nissy-tables-2.0.tar.gz |
| 56 | and extract the archive into the correct folder. | ||
| @@ -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 | 24 | A full installation of nissy requires about 3Gb of space, |
| 25 | or later the only way to get the table files is to generate them yourself. | 25 | of which 2.3Gb are occupied by the huge pruning table for fast optimal solving, |
| 26 | All but the huge table just requires a few minutes; the huge table for | ||
| 27 | optimal solving can require a couple of hours. Use more than 1 thread | ||
| 28 | if you can.* | ||
| 29 | |||
| 30 | A full installation of Nissy requires a little more than 2Gb of space, | ||
| 31 | of which 1.6Gb are occupied by the huge pruning table for fast optimal solving, | ||
| 32 | and running it requires the same amount of RAM. | 26 | and running it requires the same amount of RAM. |
| 33 | One can choose to never use this function and not to install the relative | 27 | One can choose to never use this function and not to install the relative |
| 34 | pruning table. There is an alternative (about 5 times slower) | 28 | pruning table. There is an alternative (slower) |
| 35 | optimal solving function that uses about 500Mb of RAM. | 29 | optimal 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 |
| 56 | Nissy needs to generate certain large tables to work. These tables are by default | 50 | Nissy needs to generate certain large tables to work. These tables are by default |
| 57 | generated the first time they are needed (e.g the first time you ask to solve a | 51 | generated the first time they are needed (e.g the first time you ask to solve a |
| 58 | certain step) and then saved to a file. The following times Nissy simply loads the | 52 | certain step) and then saved to a file. Whenever these tables are needed again, |
| 59 | corresponding file from the hard disk. | 53 | nissy simply loads the corresponding file from the hard disk. |
| 60 | 54 | ||
| 61 | The very large table for optimal solving can take some time to generate (about 20 | 55 | The very large table for optimal solving can take some time to generate |
| 62 | minutes 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). |
| 63 | tables are much faster. | 57 | All other tables are much faster. |
| 64 | 58 | ||
| 65 | You can ask Nissy to generate all the tables it will ever need with the **gen** | 59 | You can ask Nissy to generate all the tables it will ever need with the `gen` |
| 66 | command. It is recommended to use more than one thread, if your CPU has them. | 60 | command. It is recommended to use more than one thread, if your CPU has them. |
| 67 | For example, you can run: | 61 | For example, you can run: |
| 68 | 62 | ||
| @@ -73,17 +67,17 @@ nissy gen -t 8 | |||
| 73 | to generate all tables using 8 threads. | 67 | to generate all tables using 8 threads. |
| 74 | 68 | ||
| 75 | Alternatively, you can simply download all the tables and copy them into the | 69 | Alternatively, you can simply download all the tables and copy them into the |
| 76 | correct folder (see manual page, `ENVIRONMENT` section). | 70 | correct folder (see manual page, `ENVIRONMENT` section). On UNIX operating |
| 77 | Choose one of the following: | 71 | systems 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| | 73 | it 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 | ||
| 84 | extract the archive and copy the tables folder into `NISSIDATA` (paste there | 75 | Choose either the |
| 85 | the 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) |
| 86 | contain the huge pruning table for the optimal solver. | 77 | or the |
| 78 | [tar.gz](https://math.uni.lu/tronto/nissy/nissy-tables-2.0.tar.gz) | ||
| 79 | file (click the links to download) and | ||
| 80 | extract them in the correct folder. | ||
| 87 | 81 | ||
| 88 | ## Structure of the code | 82 | ## Structure of the code |
| 89 | 83 | ||
| @@ -3,8 +3,6 @@ | |||
| 3 | This is a list of things that I would like to add or change at some point. | 3 | This is a list of things that I would like to add or change at some point. |
| 4 | It's more of a personal reminder than anything else. | 4 | It's more of a personal reminder than anything else. |
| 5 | 5 | ||
| 6 | **Things in bold: to do before 2.0 release** | ||
| 7 | |||
| 8 | ## Commands | 6 | ## Commands |
| 9 | 7 | ||
| 10 | ### Commands that are available in nissy 1.0, but not in this version (yet): | 8 | ### Commands that are available in nissy 1.0, but not in this version (yet): |
| @@ -36,8 +34,8 @@ including e.g. solutions that were not shown because -c) | |||
| 36 | 34 | ||
| 37 | * Add EXAMPLES.md file | 35 | * Add EXAMPLES.md file |
| 38 | * webapp (cgi) | 36 | * webapp (cgi) |
| 39 | * **Re-upload tables** | 37 | * genptable: stop early if gone above base+3 (can be checked while generating) |
| 40 | * **fix README.md** | 38 | * installation: get ptables with curl or similar (on Windows what?) |
| 41 | * **fix examples in manpage** | 39 | * **fix examples in manpage** |
| 42 | 40 | ||
| 43 | ## Technical stuff | 41 | ## Technical stuff |