|
Walnut
>
Documentation
>
Nutshell ground build-up
>
master-ground-buildup.txt
master-ground-buildup.txt
$Id: master-ground-buildup.txt,v 1.1 2002/07/11 12:56:10 maryniak Exp $
Build up the whole Nutshell and related projects from the ground
(ie. source files) up.
Copyright (C) 2000-2002 University of Amsterdam
Authors: Robert Berg <rjberg@xs4all.nl>
Eric Maryniak <e.maryniak@pobox.com>
The NeuroMod Group on the Web:
http://static/
Note:
Drive "X:" is your harddisk (eg. "C:") or network drive (eg. "U:")
on which you store your local MSVC++ project and source files.
0. Install MSVC++ 6.0 with the necessary service packs (1, 2 and 3)
and STLPort, see document:
msvc-install.txt
1. Make your local Walnut work directory:
X:\Walnut
where "X:" is your harddisk drive (eg. "C:") or network drive
(eg. "U:") on which you store your local MSVC++ project and
source files.
Also create these directories in X:\Walnut, which are used by
the subsequent projects:
X:\Walnut\Release
\Debug
\Components
\Paradigms
and create a Paradigm and Examples subdirectory in the Release and
Debug directory:
X:\Walnut\Release\Paradigm
\Examples
X:\Walnut\Debug\Paradigm
\Examples
This Dos batch file will do this for you.
It is usable under Dos and in a Dos box under Windows 3.x/9x/NT/2000.
Remember to replace the target drive (X:) first, before running it:
---cut: mkwaldir.bat---
@echo off
Rem File: mkwaldir.bat
Rem Eric Maryniak (e.maryniak@pobox.com), 2000-06-07.
Rem Make necessary directories and subdirectories for the Walnut
Rem projects in X:\Walnut
Rem Change "X:" to the drive (eg. "C:" or "U:") where you want
Rem your local work copy of the Walnut and Nutshell projects:
X:
mkdir \Walnut
mkdir \Walnut\Release
mkdir \Walnut\Release\Paradigm
mkdir \Walnut\Release\Examples
mkdir \Walnut\Debug
mkdir \Walnut\Debug\Paradigm
mkdir \Walnut\Debug\Examples
mkdir \Walnut\Components
mkdir \Walnut\Paradigms
echo Walnut directories have been created in \Walnut
echo on the specified target drive.
pause
---cut: end of mkwaldir.bat---
2. Install the WalnutCore project, see document:
walnutcore-ground-buildup.txt
3. Install the Components project, see document:
components-ground-buildup.txt
4. Install the Paradigms project, see document:
paradigms-ground-buildup.txt
This installs the generic Nutshell code to support paradigms: Base.
Specific paradigms (like Hopfield or MacGregor) are also present in
the Paradigms directory but are not yet installed in this step.
5. Install the Nutshell project, see document:
nutshell-ground-buildup.txt
This document also describes how to install the CodeJock library
(CJLibrary from http://www.codejock.com/), which is necessary for the
implementation of the user interface of Nutshell.
6. Install the projects of the paradigm(s) you want to use.
You may skip this step for now, because Nutshell will work without
paradigms, although this obviously does not make much sense.
Note that you can always add more paradigms later (and rebuilding
Nutshell is not necessary), so you do not have to install all paradigms
yet. As an example we add the Hopfield paradigm, see document:
hopfield-ground-buildup.txt
Below we also describe on how to add another paradigm project
(eg. MacGregor) later, when you have already built Nutshell.
Currently (2001-03-16), eight paradigms are distributed with Nutshell:
1 - BackPropagation
2 - CALM
3 - Hopfield
4 - Kohonen
5 - LinearNodes
6 - MacGregor
7 - MacTime
8 - TraceLink
Notes:
- CALM now incorporates CalmAct
- MacTime is a variant of MacGregor
7. When you have built Nutshell (see: nutshell-ground-buildup.txt),
the WalnutCore, Components and Paradigms project will also have
been built, because Nutshell has been defined dependent on those
projects.
Note, however, that the specific paradigm(s) you want to use
(eg. Hopfield) has not been built yet. You must do this yourself
explicitly. Nutshell will work without specific paradigms, although
this does not really make sense!
Therefore, open the specific paradigm (eg. Hopfield) project, and
build it.
To use a specific paradigm, simply run Nutshell.
Nutshell does not have to be rebuilt.
Nutshell will dynamically update it's list of specific paradigms,
by scanning the paradigm sub directory for *.np files.
Nutshell looks by default in the 'Paradigm' subdirectory from which
is was started.
Thus, if you use a release version of Nutshell (ie. started from
X:\Walnut\Release) Nutshell will look in X:\Walnut\Release\Paradigm,
whereas if you use a debug version of Nutshell (ie. started from
X:\Walnut\Debug) Nutshell will look in X:\Walnut\Debug\Paradigm
Finally, Nutshell loads the found paradigms, after verifying version
number compatibility.
** Adding a paradigm.
You can add a paradigm project (eg. MacGregor) later, by loading
the project file of that paradigm and building it.
Nutshell does not have to be rebuilt and as a matter of fact does not have
to be restarted either (if it was already running), because it will detect
the new paradigm automatically when you select menu File|New.
To make a new paradigm project (eg. MacGregor), simply follow the
directions in document:
hopfield-ground-buildup.txt
and replace every occurence of "Hopfield" with "MacGregor".
It is as simple as that. Well, simple, you do have to implement the
paradigm C++ source files of course!
$Source: /home/cvsroot/Walnut/C++/Doc/internal/master-ground-buildup.txt,v $
Other relevant documents:
| 
University of Amsterdam