|
|
Walnut
>
Documentation
>
QuickStart
QuickStart
Before you start the installation of Walnut, you will need to have
Microsoft Visual C++ with Service Packs (1, 2 and 3) and STLPort installed.
Download the Walnut source code
release: a stable, unstable or development version, at your option.
QuickStart.txt:
$Id: QuickStart.txt,v 1.2 2002/07/11 22:02:39 maryniak Exp $
QuickStart text file for Walnut/Nutshell
Copyright (C) 2000-2002 University of Amsterdam
Author: Eric Maryniak <e.maryniak@pobox.com>
The NeuroMod Group on the Web:
http://static/
Introduction
============
This quick procedure describes how to build Walnut/Nutshell using the
MSVC++ project files (the *.dsp and *.dsw files).
If you want to build the project files yourself, please refer to the
'master-ground-buildup.txt' document. This is quite an elaborate process.
Be sure you have installed Microsoft Visual C++ with the necessary
Service Packs (1, 2 and 3) and STLPort.
Please refer to the 'msvc-install.txt' for detailed instructions on
how to install MSVC++, the necessary service packs and STLPort.
Quick installation procedure
============================
Nutshell has been tested on Windows 98, NT and 2000.
It also runs on Windows 95, but sometimes you may have problems with
system dll's (dynamic link libraries) and/or HTMLHelp files, especially
if you run the first release of Windows 95 and/or have an old version of
Internet Explorer.
To avoid all these problems, download the latest Internet Explorer from
Microsoft, available at the Microsoft web site at this url:
http://www.microsoft.com/ie/
On 2000-12-12, it was at version 5.5 (Service Pack 1) and Nutshell works
ok on Windows 95 when this version of Internet Explorer is installed.
You may need to install the so-called 'Plus!' package first in order to
get connected to the Internet and be able to upgrade Internet Explorer.
Steps to get you up and running quickly: first do the initial steps
A and B, which need to be done only once, and then the numeric steps.
A. Install Microsoft Visual C++ (v. 6.0) with Service Packs 1, 2 and 3
and STLPort. This is really necessary!
Refer to document 'Doc/internal/msvc-install.txt' for details.
B. Get the Walnut and Nutshell source from the NeuroMod web site:
http://static/nutshell
or directly from the ftp server
(current stable and unstable release, respectively):
ftp://neuromod.org/pub/walnut/c++/current/stable/source/
ftp://neuromod.org/pub/walnut/c++/current/unstable/source/
If you are feeling adventurous or if you are a Nutshell developer,
you can also download the latest "bleeding edge" development version,
which is extracted weekly straight from the CVS repository:
ftp://neuromod.org/pub/walnut/c++/current/devel/
With the popular Windows WinZip program (http://www.winzip.com/), you
can unpack the "tar" archive file, e.g. 'nutshell-1-0-255.tar.gz',
which contains the source, to your disk, say C:
You will now have a directory on C:, like:
C:\nutshell-1-0-255
Note that C: may also be D:, M: etc., so from now on we will refer
to the drive you choose as drive X:.
With the Explorer, rename this directory to 'Walnut', so you have:
X:\Walnut
Please note that you should _not_ put the unpacked source in a
subdirectory: the project files depend on this location, so:
X:\My C++ Projects\Walnut <=== WRONG:
Walnut may not be in a subdirectory
The directory tree you get, should look something like:
X:\Walnut\
X:\Walnut\Components
X:\Walnut\Debug
X:\Walnut\Doc
X:\Walnut\Nutshell
X:\Walnut\Paradigms
X:\Walnut\Release
X:\Walnut\WalnutCore
There are also some files in the Walnut top directory, while the
subdirectories have subdirectories themselves, too.
Now that you have installed Microsoft Visual C++ 6.0 with Service Packs
1, 2 and 3, and STLPort, you can start MSVC++.
1. Build Nutshell.
First build the Nutshell project itself and projects WalnutCore,
Components and Paradigms. Compiling Nutshell implies a build of
WalnutCore, Components and Paradigms first, because the Nutshell
project depends on those three projects.
Select menu:
File|Open Workspace
browse to:
X:\Walnut\Nutshell
and open Workspace:
Nutshell.dsw
Mark Nutshell as the active project (release mode - Win32 Release).
Select menu:
Build|Set Active Configuration...
Nutshell - Win32 Release
Then compile Nutshell and the projects it depends on.
Select menu:
Build|Build Nutshell.exe
or simply hit F7.
Normally, you should build a release version (Win32 Release),
but if you are a Nutshell developer, you can (also) build a debug
version (Win32 Debug).
After a successful build, the Nutshell executable (Nutshell.exe),
the necessary library files (*.dll, *.lib, *.exp) and (compiled)
html help file (nutshell.chm) is present in:
X:\Walnut\Debug (debug version)
X:\Walnut\Release (release version)
You can start Nutshell.exe by simply double clicking on it (Explorer),
although there is not much sense in doing so now, because we haven't
built any network paradigms (neural network models) yet.
Refer to the various Nutshell manuals for more information on how to
configure, use and program Nutshell.
For more detailed information on (re-)compiling Nutshell,
refer to document 'nutshell-ground-buildup.txt, step 9.
2. Build the paradigms you want to use.
As an example, we will build the Hopfield paradigm, but you can build
more or other paradigms exactly the same way.
Select menu:
File|Open Workspace...
browse to:
X:\Walnut\Paradigms\Hopfield
and open Workspace:
ParHopfield.dsw
Mark Hopfield as the active project (release mode - Win32 Release).
Select menu:
Build|Set Active Configuration...
ParHopfield - Win32 Release
Then compile Hopfield and the projects it depends on.
Select menu:
Build|Build Hopfield.np
or simply hit F7.
Normally, you should build a release version (Win32 Release),
but if you are a Nutshell developer, you can (also) build a debug
version (Win32 Debug).
After a successful build, the Hopfield dynamic link library,
Hopfield.np (note extension .dll in lieu of .np), is present in:
X:\Walnut\Debug\Paradigm (debug version)
X:\Walnut\Release\Paradigm (release version)
For more detailed information on (re-)compiling paradigms,
refer to document 'master-ground-buildup.txt, step 6 and then for
every paradigm (e.g. see 'hopfield-ground-buildup.txt'), step 9.
This step should be repeated for every paradigm you want to use.
This is the list of currently available paradigms
(Nutshell 1.0.255, 2002-01-07):
1 - Walnut\Paradigms\BackPropagation\ParBackPropagation.dsw
2 - Walnut\Paradigms\CALM\ParCalm.dsw
3 - Walnut\Paradigms\Hopfield\ParHopfield.dsw
4 - Walnut\Paradigms\Kohonen\ParKohonen.dsw
5 - Walnut\Paradigms\LinearNodes\ParLinearNodes.dsw
6 - Walnut\Paradigms\MacGregor\ParMacGregor.dsw
7 - Walnut\Paradigms\MacTime\ParMacTime.dsw
8 - Walnut\Paradigms\TraceLink\ParTraceLink.dsw
3. Start Nutshell.
The Nutshell executable is present in directory:
X:\Walnut\Debug (debug version)
X:\Walnut\Release (release version)
You can start Nutshell.exe by simply double clicking on it (Explorer)
and it will detect automatically which paradigms are available by
scanning subdirectory Paradigm (in X:\Walnut\Debug or X:\Walnut\Release).
Normally, you should use the release version.
Nutshell developers will often use the debug version, especially
when they are, well, debugging!
$Source: /home/cvsroot/Walnut/C++/Doc/internal/QuickStart.txt,v $
Other relevant documents:
|
University of Amsterdam