nissy-classic

Stable branch of nissy
git clone https://git.tronto.net/nissy-classic
Download | Log | Files | Refs | README | LICENSE

index.html (7928B)


      1 <!doctype html>
      2 <html lang="en">
      3 <head>
      4 	<title> Nissy </title>
      5 	<meta name="viewport" content="width=device-width" />
      6 	<link rel="stylesheet" type="text/css" href="/style-3.css">
      7 	<link rel="icon" href="/favicon.png">
      8 	<meta charset="utf-8">
      9 </head>
     10 
     11 <body>
     12 
     13 <h1>Nissy</h1>
     14 
     15 <p class=subtitle>A Rubik's cube solver and FMC assistant</p>
     16 
     17 <p>
     18 Nissy is a command-line Rubik's cube solver. It can find optimal solutions
     19 for random positions using techniques from Herbert Kociemba's
     20 <a href="http://kociemba.org/cube.htm">Cube Explorer</a> and
     21 Tomas Rokicki's
     22 <a href="https://github.com/rokici/cube20src/blob/master/nxopt.md">nxopt</a>.
     23 With 4 cores at 2.5GHz and using about 3Gb of RAM, Nissy can find an optimal
     24 solution in about a minute on average.
     25 </p>
     26 
     27 <p>
     28 Nissy aims at being a complete tool
     29 for FMC (Fewest Moves Challenge) practice. It can solve different steps
     30 of Thistlethwaite's algorithm (also know as DR/HTR) and cans use NISS
     31 (Normal-Inverse Scramble Switch).
     32 </p>
     33 
     34 <p>
     35 You should use Nissy if:
     36 </p>
     37 <ul>
     38 <li>
     39 You want to analyze your DR solutions or check for multiple optimal
     40 (or sub-optimal) solutions for EO/DR/HTR or similar steps.
     41 </li>
     42 <li>
     43 You just want a Rubik's cube solver and you like command line interfaces.
     44 </li>
     45 <li>
     46 You want an alternative to Cube Explorer.
     47 </li>
     48 </ul>
     49 
     50 <p>
     51 To get started, head to the <a href="/download/">download</a> page.
     52 </p>
     53 
     54 <p>
     55 You can also look at its source code by cloning the git repository:
     56 </p>
     57 
     58 <pre>
     59 <code>git clone https://git.tronto.net/nissy-classic</code>
     60 </pre>
     61 
     62 <p>
     63 For a summary of changes and a list of older versions see the bottom of
     64 this page. Some versions (for example 1.0) are not available directly,
     65 but can be obtained from the git repository.
     66 </p>
     67 
     68 <h2 id="Installation">Installation</h2>
     69 
     70 <p>
     71 You can get the latest version of nissy at the following links:
     72 </p>
     73 
     74 <table class="dltable">
     75 <tr>
     76 	<td></td>
     77 	<td><strong>Source code</strong></td>
     78 	<td><strong>Windows executable</strong></td>
     79 </tr>
     80 <tr>
     81 	<td><strong>Latest version</strong></td>
     82 	<td><a href="/nissy-2.0.7.tar.gz">nissy-2.0.7.tar.gz (71Kb)</a></td>
     83 	<td><a href="/nissy-2.0.7.exe">nissy-2.0.7.exe (743Kb)</a></td>
     84 </tr>
     85 </table>
     86 
     87 <h3>System requirements</h3>
     88 
     89 <p>
     90 A full installation of nissy requires about 3.1Gb of space,
     91 of which 2.3Gb are occupied by the huge pruning table for fast optimal solving,
     92 and running it requires the same amount of RAM.
     93 One can choose to never use this function and not to install the relative
     94 pruning table. There is an alternative (slower)
     95 optimal solving function that uses about 500Mb of RAM.
     96 
     97 When generating the pruning tables automatically (see the section Tables below),
     98 at least 5.3Gb or RAM are required.
     99 </p>
    100 
    101 <h3>Windows</h3>
    102 
    103 <p>
    104 Try downloading and executing in a terminal the file <code>nissy.exe</code>,
    105 then follow the instructions in the <strong>Tables</strong> section below for
    106 installing the pruning tables.
    107 If <code>nissy.exe</code> does not work, you can try following the UNIX instructions
    108 in WSL (Windows Subsystem for Linux) or in a similar environment.
    109 </p>
    110 
    111 <h3>UNIX (Linux, MacOS, *BSD...)</h3>
    112 <p>
    113 Download the source archive (.tar.gz). Extract it
    114 with your favorite archive program, for example with
    115 </p>
    116 <pre><code>tar -xvzf nissy-VERSION.tar.gz</code></pre>
    117 <p>
    118 Open a terminal in the directory just extracted.
    119 If you wish, edit the <code>Makefile</code> to match your local configuration
    120 (this is usually not necessary, but you may want to change the
    121 <code>PREFIX</code> variable to change the installation path) and run
    122 <pre><code>make</code></pre>
    123 <p>
    124 followed by
    125 </p>
    126 <pre><code>make install</code></pre>
    127 <p>
    128 Then follow the instructions below to install the pruning tables.
    129 </p>
    130 
    131 <h3>Tables</h3>
    132 
    133 <p>
    134 Once you have installed nissy, run
    135 </p>
    136 
    137 <pre><code>nissy gen</code></pre>
    138 
    139 <p>
    140 to generate all the tables that Nissy will ever need.
    141 Running this command requires around 5.3Gb of RAM, and it can take some time
    142 (about 90 minutes on my 9 year old but laptop, with 4 CPU threads).
    143 </p>
    144 
    145 <p>
    146 Some unnecessary technical detail: by default this command is going to use
    147 at most 64 threads. If you want you can choose to use more threads (if your CPU
    148 is very powerful) or fewer threads (if you for example want to run this command
    149 in the background while you do other stuff) with the <code>-t</code> option, for
    150 example <code>nissy gen -t 1</code>.
    151 </p>
    152 
    153 <p>
    154 Alternatively, you can
    155 <a href="/nissy-tables-2.0.4.zip">download all the tables (1.7Gb)</a> and
    156 copy them into the correct folder (see manual page, <code>ENVIRONMENT</code>
    157 section). On UNIX operating systems this folder is either
    158 <code>.nissy/tables</code> in the user's home directory or
    159 <code>$XDG_DATA_HOME/nissy/tables</code> if the XDG variable is configured.
    160 On Windows it is the same directory as the <code>nissy.exe</code> executable
    161 file.
    162 </p>
    163 
    164 <h2 id="Upgrade">Upgrading</h2>
    165 <p>
    166 <strong> Upgrading from 2.0.4 or later to any later version: </strong>
    167 Follow the general upgrading instructions below, no other step required.
    168 </p>
    169 <p>
    170 <strong> Important note for upgrading to 2.0.4:</strong>
    171 A bug in 2.0.3 and earlier versions caused HTR-related tables to be
    172 generated incorrectly on ARM platforms (Mac M1, Android...).
    173 If you are upgrading to 2.0.4 on such a device, you need to re-generate
    174 these tables. You can do this by removing all the files wiht <code>htr</code>
    175 in their name and let nissy re-generate them (after upgrading), or by
    176 downloading the <a href="/nissy-tables-2.0.4.zip">new tables</a> and
    177 replacing the old ones.
    178 </p>
    179 <p>
    180 <strong> General upgrading instrutions </strong>
    181 If you already have nissy installed and you want to upgrade to a more
    182 recent version, you can simply repeat the installation process:
    183 </p>
    184 <ul>
    185 <li>
    186 On Windows: simply replace nissy.exe with the new file with the same name.
    187 </li>
    188 <li>
    189 On UNIX systems: download the new version of the source code, extract it in
    190 a new folder and run <code>make</code> and <code>make install</code> again.
    191 </li>
    192 </ul>
    193 <p>
    194 Between each version new table files might have been added, or old ones
    195 may be not used anymore. Nissy will deal with this automatically unless
    196 otherwise reported in this page (see above).
    197 </p>
    198 
    199 <h2>Version history</h2>
    200 
    201 <h3>Nissy v2</h3>
    202 
    203 <table class=dltable>
    204 <tr>
    205 	<td><strong>Version</strong></td>
    206 	<td><strong>Date</strong></td>
    207 	<td><strong>Comment</strong></td>
    208 </tr>
    209 <tr>
    210 	<td><a href="/nissy-2.0.7.tar.gz">2.0.7</a></td>
    211 	<td>2024-06-28</td>
    212 	<td>Improved solution ordering; print less solutions for
    213 	htr and drslice; fixed bugs.</td>
    214 </tr>
    215 <tr>
    216 	<td><a href="/nissy-2.0.6.tar.gz">2.0.6</a></td>
    217 	<td>2023-09-24</td>
    218 	<td>Added: drfin step; solve -L option; ptable command.
    219 	Better ordering for output of many solutions.</td>
    220 </tr>
    221 <tr>
    222 	<td><a href="/nissy-2.0.5.tar.gz">2.0.5</a></td>
    223 	<td>2023-08-16</td>
    224 	<td>Bugfix: DR from EO did not check both sides</td>
    225 </tr>
    226 <tr>
    227 	<td><a href="/nissy-2.0.4.tar.gz">2.0.4</a></td>
    228 	<td>2023-05-03</td>
    229 	<td>Fixed bug on ARM; added corners-dr step</td>
    230 </tr>
    231 <tr>
    232 	<td><a href="/nissy-2.0.3.tar.gz">2.0.3</a></td>
    233 	<td>2022-09-10</td>
    234 	<td>Fixed bug in scramble dr</td>
    235 </tr>
    236 <tr>
    237 	<td><a href="/nissy-2.0.2.tar.gz">2.0.2</a></td>
    238 	<td>2022-06-01</td>
    239 	<td>Improved table generation speed</td>
    240 </tr>
    241 <tr>
    242 	<td><a href="/nissy-2.0.1.tar.gz">2.0.1</a></td>
    243 	<td>2022-02-22</td>
    244 	<td>Bugfix release</td>
    245 </tr>
    246 <tr>
    247 	<td>2.0</td>
    248 	<td>2021-12-29</td>
    249 	<td>Rewritten from scratch; much faster optimal solver</td>
    250 </tr>
    251 </table>
    252 
    253 <h3>Nissy v1</h3>
    254 
    255 <p>
    256 Nissy v1 was released in 2020. It was slow, full of bugs and the code
    257 was quite terrible. But in practice it got its job done most of the time.
    258 </p>
    259 
    260 <hr class="line">
    261 
    262 <nav class="bottom">
    263 	<table class="footer">
    264 	<tr>
    265 	<td class="contact">
    266 		<a href="https://sebastiano.tronto.net">sebastiano.tronto.net</a>
    267 	</td>
    268 	<td class="hosted">
    269 		<a href="mailto:sebastiano@tronto.net">
    270 			sebastiano@tronto.net
    271 		</a>
    272 	</td>
    273 	</tr>
    274 	</table>
    275 </nav>
    276 
    277 </body>
    278 </html>