NeuroGrid - P2P Bookmark Organiser

File Release Notes and Changelog

Release Name: 0.1.0

Notes:
****************=====NG_SIMULATOR=====****************

This file contains information relating to the simulator and what to do if ant fails to work.
Please check http://www.neurogrid.net/ for more information on NeuroGrid and this simulator.
Don't hesitate to mail neurogrid-devel@lists.sourceforge.net with any questions.

So if you can't get ant (the make tool) to work on your system, your first recourse should be to check the ant documentation.

http://jakarta.apache.org/ant/manual/index.html

Once you've got the ANT_HOME, JAVA_HOME variables set, and added ng_simulator/ant/bin to your path you should be able to run commands like:

ant javadoc
ant                // this will build the java classes
ant applet_jar
ant clean

etc.  Although you may also need to increase the amount of environment space allocated (a problem with win98), and add the ant library jars to your classpath.

If setting up ant seems like to much trouble, here are the commands that will allow you to build the simulator, run it and create the jar file needed to get the applet GUI working.

***Compiling the source code***

javac com/neurogrid/simulation/*.class

***Running the simulations***

java com.neurogrid.simulation.SimpleNetwork ?
java com.neurogrid.simulation.FreenetNetwork ?

will give you the usage information on how to give parameters to the Network objects and run a simple search

java com.neurogrid.simulation.Simulation

and

java com.neurogrid.simulation.AdvancedSimulation

Will run multiple searches through networks created from specifications in the parameter files PARAMETER.properties and ADVANCED_PARAMETER.properties respectively.
Please be careful about which parameter file is being refered to since the files are accessed relative to the class path, so that if a classes, or build directory is created, the parameters files must be placed in the com/neurogrid/simulation directory.  We'll try and fix up less hazardous arrangement in future.

***Creating the jar file***

move to the src directory and use this command
jar cvf Simulator.jar com/neurogrid/simulation/*.class com/neurogrid/simulation/root/*.class com/neurogrid/parser/MultiHashtable.class

====CAUTION====

In order for the applet to work in IE you may have to remove the Freenet classes since they use Set classes that are not supported by the Microsoft MVM.
It seems that even the presence of these classes in the jar package (even if they are not called) can stop the applet from running in IE.
If you can get ant working then the ant applet_jar command will create a jar file that excludes the Freenet classes.

====NOTE===

We make no claims that the Freenet simulator corresponds exactly to a particular version of Freenet.  The code is based on Ian Clarke's original Freenet paper, and subsequent discussions on the Freenet mailing list.

Changes:
Well I'm still not keeping a great change log :-(

This 0.1 release has got loads of new things.  The code architecture has been restructured to make things easier for people to extend and create their own p2p simulations.

There is source code for an applet GUI, build.xml files for ant.  We'll have a more organised change log as soon as I get more organised.