aboutsummaryrefslogtreecommitdiff
path: root/www/download/index.html
blob: b115244904a053a2bca954d72fff064327b2ca8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<!doctype html>
<html lang="en">
<head>
	<title> Download | Nissy </title>
<meta name="viewport" content="width=device-width" />	<link rel="stylesheet" type="text/css" href="/style.css">
	<link rel="icon" href="/favicon.png">
	<meta charset="utf-8">
</head>

<body>

<nav class="top">
	<table class="menu">
	<tr>
	<td class="logo"> <a href="/"><img src="/favicon.png" alt="logo"></a> </td>
	<td class="links">
		<a href="/download/">Download</a> |
		<a href="/examples/">Examples</a>
	</td>
	</tr>
	</table>
</nav>

<hr class="line">


<h1>Get Nissy</h1>

<table class="dltable">
<tr>
	<td></td>
	<td><strong>Source code</strong></td>
	<td><strong>Windows executable</strong></td>
</tr>
<tr>
	<td><strong>Latest version</strong></td>
	<td><a href="/nissy-2.0.2.tar.gz">nissy-2.0.2.tar.gz (67Kb)</a></td>
	<td><a href="/nissy-2.0.2.exe">nissy-2.0.2.exe (780Kb)</a></td>
</tr>
</table>

<p>
In this page you can find download links (see above),
<a href="#Installation">installation instructions</a> and
<a href="#Upgrade">upgrade instructions</a>
for nissy. If instead you wish to clone the
<a href="https://git.tronto.net/nissy/">git repository</a>,
you can use git:
</p>

<pre>
<code>git clone https://git.tronto.net/nissy</code>
</pre>

<p>
For a summary of changes and a list of older versions see below. Some versions
(for example 1.0) are not available directly, but can be obtained from
the git repository.
</p>

<h2 id="Installation">Installation</h2>

<h3>System requirements</h3>

<p>
A full installation of nissy requires about 3.1Gb of space,
of which 2.3Gb are occupied by the huge pruning table for fast optimal solving,
and running it requires the same amount of RAM.
One can choose to never use this function and not to install the relative
pruning table. There is an alternative (slower)
optimal solving function that uses about 500Mb of RAM.

When generating the pruning tables automatically (see the section Tables below),
at least 5.3Gb or RAM are required.
</p>

<h3>Windows</h3>

<p>
Try downloading and executing in a terminal the file <code>nissy.exe</code>,
then follow the instructions in the <strong>Tables</strong> section below for
installing the pruning tables.
If <code>nissy.exe</code> does not work, you can try following the UNIX instructions
in WSL (Windows Subsystem for Linux) or in a similar environment.
</p>

<h3>UNIX (Linux, MacOS, *BSD...)</h3>
<p>
Download the source archive (.tar.gz). Extract it
with your favorite archive program, for example with
</p>
<pre><code>tar -xvzf nissy-VERSION.tar.gz</code></pre>
<p>
Open a terminal in the directory just extracted.
If you wish, edit the <code>Makefile</code> to match your local configuration
(this is usually not necessary, but you may want to change the
<code>PREFIX</code> variable to change the installation path) and run
<pre><code>make</code></pre>
<p>
followed by
</p>
<pre><code>make install</code></pre>
<p>
Then follow the instructions below to install the pruning tables.
</p>

<h3>Tables</h3>

<p>
Once you have installed nissy, run
</p>

<pre><code>nissy gen</code></pre>

<p>
to generate all the tables that Nissy will ever need.
Running this command requires around 5.3Gb of RAM, and it can take some time
(about 40 minutes on my fairly old but decent laptop, with 8 CPU threads).
</p>

<p>
Some unnecessary technical detail: by default this command is going to use
at most 64 threads. If you want you can choose to use more threads (if your CPU
is very powerful) or fewer threads (if you for example want to run this command
in the background while you do other stuff) with the <code>-t</code> option, for
example <code>nissy gen -t 1</code>.
</p>

<p>
Alternatively, you can
<a href="/nissy-tables-2.0.2.zip">download all the tables (1.7Gb)</a> and
copy them into the correct folder (see manual page, <code>ENVIRONMENT</code>
section). On UNIX operating systems this folder is either
<code>.nissy/tables</code> in the user's home directory or
<code>$XDG_DATA_HOME/nissy/tables</code> if the XDG variable is configured.
On Windows it is the same directory as the <code>nissy.exe</code> executable
file.
</p>

<h2 id="Upgrade">Upgrading</h2>
<p>
If you already have nissy installed and you want to upgrade to a more
recent version, you can simply repeat the installation process:
</p>
<ul>
<li>
On Windows: simply replace nissy.exe with the new file with the same name.
</li>
<li>
On UNIX systems: download the new version of the source code, extract it in
a new folder and run <code>make</code> and <code>make install</code> again.
</li>
</ul>
<p>
Between each version new table files might have been added, or old ones
may be not used anymore. Nissy will deal with this automatically.
</p>

<h2>Version history</h2>

<h3>Nissy v2</h3>

<table class=dltable>
<tr>
	<td><strong>Version</strong></td>
	<td><strong>Date</strong></td>
	<td><strong>Comment</strong></td>
</tr>
<tr>
	<td><a href="/nissy-2.0.2.tar.gz">2.0.2</a></td>
	<td>2022-06-01</td>
	<td>Improved table generation speed</td>
</tr>
<tr>
	<td><a href="/nissy-2.0.1.tar.gz">2.0.1</a></td>
	<td>2022-02-22</td>
	<td>Bugfix release</td>
</tr>
<tr>
	<td>2.0</td>
	<td>2021-12-29</td>
	<td>Rewritten from scratch; much faster optimal solver</td>
</tr>
</table>

<h3>Nissy v1</h3>

<p>
Nissy v1 was released in 2020. It was slow, full of bugs and the code
was quite terrible. But in practice it got its job done most of the time.
</p>


<hr class="line">

<nav class="bottom">
	<table class="footer">
	<tr>
	<td class="contact">
		<a href="https://sebastiano.tronto.net">sebastiano.tronto.net</a>
	</td>
	<td class="hosted">
		<a href="mailto:sebastiano@tronto.net">
			sebastiano@tronto.net
		</a>
	</td>
	</tr>
	</table>
</nav>

</body>
</html>

Generated with cgit - Back to sebastiano.tronto.net