home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 7 / Apprentice-Release7.iso / Source Code / C ++ / Applications / NeuroSim 1.0.2 / Documentation / Read Me (NeuroSim) < prev   
Encoding:
Text File  |  1997-03-25  |  6.7 KB  |  183 lines  |  [TEXT/ttxt]
  1. _______________________________________________________________
  2. NeuroSim — A freeware Mac application
  3. Version 1.0.2 (March 1997)
  4.  
  5. By Timo Eloranta
  6. Copyright © 1996-97 Brown Eyes Software
  7. All rights reserved.
  8.  
  9. Internet e-mail:  timo.eloranta@ac.com        
  10. _______________________________________________________________
  11.  
  12. Contents
  13.  
  14.   •  Description
  15.   •  System Requirements
  16.   •  How to "Play"...
  17.   •  Known Weaknesses
  18.   •  Version History
  19.   •  Credits & Acknowledgments
  20.   •  Distribution
  21.   •  Fine Print
  22.   •  One More Disclaimer...
  23.   •  Contacting the Author
  24.  
  25.  
  26. Description
  27.  
  28. NeuroSim is a simple neural net simulator. A neural net is formed
  29. by a matrix of connected neurons. Every neuron has a state which is
  30. described with an integer. Every neuron also has a border value, which
  31. equals the number of connections starting from the neuron. When the
  32. state of the neuron exceeds the neuron's border value, the neuron lights
  33. up and sends an impulse to all the neurons it's connected to. The impulse
  34. increases the state of every connected neuron by one. After lighting up
  35. the neuron's state returns to zero.
  36.  
  37. NeuroSim allows the user to create new neural nets with specified
  38. characteristics and to "play" with the nets by manually lighting up
  39. certain neurons (known as receptors). There's also a demo mode...
  40.  
  41.   
  42. System Requirements
  43.  
  44.   •  a Mac equipped with a 68020 or greater CPU
  45.   •  MacOS 7.0 or later
  46.   •  about 500 K of free RAM
  47.   •  a color monitor
  48.   •  ObjectSupportLib (only PowerMacs need this)
  49.  
  50.   •  Note: NeuroSim is a "fat binary" and runs entirely in native PowerPC
  51.       code if you have a PowerMacintosh (or compatible) !
  52.  
  53.  
  54. How to "Play"...
  55.  
  56. Before creating a new net you can use the Parameters dialog to
  57. set some attributes. You can specify the desired quantity of connections
  58. starting from every neuron. You can also set the average horizontal and
  59. vertical length for the connections, as well as the allowed deviation from
  60. these average values. (If you set the deviation values to 0, all of the
  61. connections will have a uniform length and direction.) Note that both the
  62. average vertical and horizontal length can have negative values (to the
  63. left and down...), but deviation values are always non-negative. Finally,
  64. you can set the net size with the slider (min.: 2x2; max.: 14x14).
  65.  
  66. To create a new net use the "New" command (brilliant, eh?).
  67. The number in each neuron is it's current state. The colors also have
  68. a specific meaning (this is why you really should have a color screen
  69. to use this toy). Red means that the neuron is in its border state and
  70. will light up from the next incoming impulse (Note that neurons with
  71. no outgoing connections are red right from the beginning.) Green means
  72. that that the neuron is in "0-state" (and below its border state...).
  73. Neurons which are between 0-state and their border state are drawn
  74. in blue color. When a neuron lights up, it's drawn with yellow.
  75.  
  76. There are two things you can do to the neurons. Firstly, the neurons
  77. on the left side (in the 1st column) are so called receptors. You can
  78. force any receptor to light up by simply clicking it with the mouse.
  79. Secondly, you can check the "outgoing" connections of any neuron.
  80. With normal neurons (not receptors) this is done by clicking with the
  81. mouse. With receptors you also need to hold down the option-key
  82. in order to not to light the receptor up. In both cases the connections
  83. are shown as long as the mouse button is held down.
  84.  
  85. Finally, if you're too lazy to click them receptors yourself, you can
  86. switch NeuroSim to demo mode with the "Start Demo" command.
  87. Finding out the way to return back to "manual drive" is left as an
  88. exercise to the reader...
  89.  
  90.  
  91. Known Weaknesses
  92.  
  93. I wrote NeuroSim in 9 days in January '96 for a programming class at
  94. the University of Tampere. The essential weakness of the application
  95. must be its lack of a real purpose... As a simulator it is "toyish" at best
  96. and if it were supposed to be a game it should have a goal of some sort.
  97.  
  98. NeuroSim will probably be most useful to other programmers, since the
  99. complete source code is freely available (in a separate archive).
  100.  
  101.         
  102. Version History
  103.  
  104. 1.0.2        24 Mar 1997
  105.                         •    First release featuring "grayscale appearance" controls.
  106.                         •    Compiled with CodeWarrior 11.
  107.  
  108. 1.0.1        07 Jul 1996
  109.                         •    Maintenance release (new contact info).
  110.                         •    No bug fixes (no bugs...) or new features.
  111.                         •    Compiled with CodeWarrior 9.
  112.  
  113. 1.0         19 Feb 1996
  114.               •    Initial public release.
  115.  
  116.  
  117. Credits & Acknowledgments
  118.  
  119.   •  First of all, my thanks to Leena Heino and Mika Niemelä, who 
  120.       helped me to design NeuroSim 1.0.
  121.  
  122.   •  Secondly, I'd like to thank Leo Breebaart for testing and his
  123.       encouraging comments.
  124.       
  125.   •  Special thanks to James Jennings (jennings@halcyon.com) whose
  126.       AGA Slider control NeuroSim uses for the slider in the Parameters dialog.
  127.       The latest version of AGA Slider can always be found at
  128.       <ftp://ftp.halcyon.com/pub/users/jennings/>.
  129.  
  130.   •  NeuroSim 1.0.2 was created using CodeWarrior 11 (by Metrowerks)
  131.       and ResEdit 2.1.3 (by Apple). I highly recommend the PowerPlant 
  132.       framework which is part of the CodeWarrior package.  
  133.  
  134.   •  Folder icon was made with Folder Icon Maker 1.5 by Greg Robbins.
  135.  
  136.   •  File dates where unified with MacDater 1.3 by Tommy Widenflycht.
  137.   
  138.   
  139. Distribution  
  140.  
  141. NeuroSim is freeware, which means that you can use the program for free
  142. but that I still retain the copyright. More specifically, this program cannot
  143. be sold for a profit or distributed thru a commercial channel 
  144. without my written consent. Distribution via online services, BBS's,
  145. Internet, person-to-person and other non-commercial means is acceptable
  146. provided that all original and unaltered files are included in the package. 
  147.  
  148.  
  149. Fine Print
  150.  
  151. [  Here comes the more or less obligatory boring stuff...  ]
  152.  
  153. NeuroSim is supplied "as is". The author makes no warranties, either express
  154. or implied, and will not be liable for any special, incidental, consequential
  155. or indirect damages, including but not limited to loss of data or psychological
  156. damage. The person using this software bears all risk as to its quality and
  157. performance. By using this software, you are subject and agree to the terms
  158. in this disclaimer. In short, use NeuroSim at your own risk.
  159.  
  160.  
  161. One More Disclaimer...
  162.  
  163. My current employer, which some of you might guess from my e-mail address,
  164. has absolutely _nothing_ to do with NeuroSim or other programs which I've
  165. released under the title of Brown Eyes Software. Clear enough ?
  166.  
  167.  
  168. Contacting the Author
  169.  
  170. For questions, praise, bug reports (oh no!), comments and job offers, I can be
  171. reached via Internet e-mail at
  172.  
  173.   timo.eloranta@ac.com
  174.  
  175. or by "snail mail" (the postcard count is still steadily at zero...) at
  176.  
  177.   Timo Eloranta
  178.   Vänrikki Stoolin katu 10B A2
  179.   FIN-00100 Helsinki
  180.   Finland (Europe)
  181.  
  182. _______________________________________________________________
  183.