home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Science / chemistry / BeakerBoy.0.31.README < prev    next >
Encoding:
Text File  |  1995-02-15  |  10.1 KB  |  283 lines
  1. Release 0.31, 7.1.1995 by Thomas Engel (tomi@shinto.nbg.sub.org)
  2.  
  3.  
  4.  
  5.             The BeakerBoy Application
  6.  
  7. ATTENTION..you need gnutar and gzip to unpack this package.
  8.  
  9.  
  10. This nice guy is trying to provide a basic framework for chemical
  11. vizualization. It serves as the center of a possible collection of
  12. many different chemistry tools that should be able to cooperate
  13. accross a network and different hardware platforms. As a main goal I
  14. want to create a flexible app design that is very simple to extend
  15. via additional bundles and able to interoperate with other
  16. applications or the SCITools project from the EMBL-Heidelberg.
  17.  
  18.  
  19.  
  20.         The current Release
  21.  
  22.  
  23. Version 0.31 still has to be considered as an alpha version that is
  24. under development and might change a lot. To get a little impression
  25. of the things I have in mind for the releases yet to come read the
  26. second chapter of this documentation. I would like to get any kind of
  27. feedback from other programmers or chemist to make this app more
  28. intuitive, flexible and maybe find some better solutions.
  29.  
  30. All you can do with the current version is:
  31.  
  32.     1.    Load some sample molecules.     
  33.     2.    Create new regions by grouping either atoms or bonds.     
  34.     3.    Use the Inspector to adjust the graphical parameters (color,
  35.           styles, etc.).
  36.     4.    Doubleclick any collection of selected regions to show them.     
  37.     5.    Rotate the molecules using the RotatorPanel or the 
  38.           3DDeviceServer.     
  39.     6.    Print the views.
  40.  
  41. Every view you see will be drawn using the settings valid at the
  42. moment of creation! Later changes won't affect any already visible
  43. view. Right now you might consider this as a feature because you
  44. might open the same region with as many different settings as you
  45. like. But this definitly will change in the future.
  46.  
  47.  
  48. The Package
  49.  
  50. This release come with the following resources. They are split in
  51. seperate packages to give you the freedom of only downloading the
  52. parts you are interested in.
  53.  
  54.  -  BeakerBoy.app & Documentation.     
  55.     The BeakerBoy.0.31.NIHS.bd.tar.gz archive contains a plug'n'play 
  56.     binary for NeXT, Intel, HP and Sparc hardware that was compiled 
  57.     under NeXTSTEP 3.3. It also includes the documentation.
  58.  
  59.  -  Source.     
  60.     In  BeakerBoy.0.31.s.tar.gz you can find the complete source code 
  61.     for this project. More details on compiling are included below.
  62.  
  63.  -  LookMolecules.     
  64.     If you want an example molecule collection get the M-1 since 
  65.     BeakerBoy v0.2 still unchangedM-1 BeakerBoy-LookMolecules.0.1.d.tar.gz 
  66.     archive. This package has its seperate version number.
  67.  
  68. The latest release should be available in the /Science/Chemistry area
  69. of the following NeXT ftp servers:
  70.  
  71.     ftp.nmr.embl-heidelberg.de     
  72.     ftp.informatik.uni-muenchen.de
  73.     ftp.cs.orst.edu
  74.  
  75. You might also check out the projects section of my WWW homepage. It
  76. can be found at:
  77.  
  78.     http://wwwcip.informatik.uni-erlangen.de/user/tsengel/ 
  79.  
  80.  
  81. All it does
  82.  
  83. This is a quick summary of the features this version offers. A
  84. complete history of all the versions, their features and the
  85. currently known bugs can be found inside the Release Notes.
  86.  
  87. v0.31   - Better 3DDeviceServer support.     
  88.         - A basic PDB filefilter.     
  89.         - Compiles on HP and Sparc hardware just fine...out of the box.
  90.             
  91. v0.3    - 3DDeviceServer support for using 3D mouse devices.
  92.         - More filefilters (Look3D, Alchemy, MacMolecule, MVT)
  93.         - Uses the IconKit for drag&drop.     
  94.         - Allows simple grouping which will creat regions.     
  95.         - Few preferences (background color, and 3DMouse on/off).     
  96.         - Uses different render settings for rotation and displaying.     
  97.         - Printing the views.
  98.  
  99. v0.2    - Load multiple molecules (Look3D format) and show them
  100.           with multiple camera views using different styles. The 
  101.           coordinate system is left-handed (x to the right, y upwards 
  102.           and z into the screen. The camera is positioned on the 
  103.           negative z axis). I'm not sure if this is the common 
  104.           orientation ? If not, please give me a hint.     
  105.         - Rotate molecules.     
  106.         - Set different molecule styles and rendering qualities. 
  107.           (Hollow Sticks, Round Sticks, Balls & Sticks, Spacefilling 
  108.           CPK)     
  109.         - Show a nice interface with no function at all...hold on for 
  110.           a while to see a lot of thing get implemented and improved.
  111.  
  112.  
  113. Bright Future
  114.  
  115. Here is a rough overview of my privat timetable for this project.
  116. Given the fact that I'm a student it might be possible to make it a
  117. non-vapour project :-) But after all. Time passes on...deadlines
  118. slip...nobody cares. More details can be found in the next chapter:
  119.  
  120. ('95)   - Load, save, new, ... basic stuff.     
  121.         - More and better fileFilters. (PDB high on the list)     
  122.         - Helppages.
  123.         - Using Bundles.     
  124.         - Simple stereo-camera.    
  125.         - Molecule construction from basic fragments. (atoms,
  126.           bonds, molecules)     
  127.         - A simple German localization.
  128. ('96)   - Tools executable on remote machines via PDO: HP, Sun, 
  129.           SGI, DEC servers?     
  130.         - StructureBoy...a 2D chemistry drawing tool.         
  131.         - Nice clipping planes. Other drawing styles.
  132.         - Protein building tool.     
  133.         - Energy optimization.
  134. ('99)   - Direct brain-slot adaptor and other simple extentions.
  135.         - ...include here what you like. It might get real.
  136.  
  137.  
  138.  
  139.          More Details
  140.  
  141.  
  142. I am trying to make it as NeXTSTEP' ish as possible. Full Drag&Drop,
  143. Object Links etc. will definitly be added someday. There will be APIs
  144. for any kind of loadable bundle or service link. DOs will find their
  145. way into this project too. It is almost ideal for creating server
  146. based number crunching analysis tools. And once the SCITools project
  147. gets going I will try to make BeakerBoy compatible or what ever might
  148. be necessary to allow easy coexistance.
  149.  
  150. As said before. This app wants to provide a well defined API,
  151. reusable objects and a flexible concept. It is not designed to
  152. squeeze the last bit out of memory or CPU performance. The basic idea
  153. is to provide useful working speed with almost any molecule size on
  154. any hardware. This will need a wide variety of QRenderMan settings.
  155. For really impressive pictures I might add some kind of link to
  156. solidModeller, intuitiv3D, etc. (some basic shading stuff will be
  157. included in BeakerBoy too).
  158.  
  159. Feel free to send comments on the app, interface, molecule files or
  160. what ever. But please just send messages with useable
  161. information...not something like: "I hate it"...please say why you
  162. hate it  ;o)
  163.  
  164. If you are interested in chemistry on NeXTSTEP checkout MolViewer by
  165. Steve Ludtke. Not as pretty as my app :-) but a lot more useful (at
  166. the moment). Georg Tuparev from the EMBL-Heidelberg is writing a
  167. frontend to MolScript, porting WHATIF and working on the SCITools.
  168. Maybe those projects are interesting to you too.
  169.  
  170.  
  171. Compiling
  172.  
  173. Sorry, you will need the latest versions of the IconKit and MiscKit
  174. to compile the app. Some objects which have been included in v0.3
  175. moved to the MiscKit and are no longer present in this project. If you
  176. are interested in programming you should get those libraries anyway.
  177. There are many good, reusable objects in there.
  178.  
  179.  
  180. What is the 3DDeviceServer
  181.  
  182. To allow the user to rotate and move a molecule BeakerBoy uses the
  183. 3DDeviceServer.app. It is a DO based server app that does control the
  184. access to any kind of 3D hardware..as long as there is a driver for
  185. it. It is also available at all the major NeXTSTEP ftp-sites listed
  186. above.
  187.  
  188.  
  189. In Case of Trouble
  190.  
  191. If you have any questions you might contact me.
  192.  
  193.     Thomas Engel     
  194.     Netpunstr. 9     
  195.     D-90522 Oberasbach 
  196.     Germany          
  197.     
  198.     E-mail: tsengel@cip.informatik.uni-erlangen.de 
  199.             tomi@shinto.nbg.sub.org
  200.  
  201.             (NeXTMail welcome)
  202.  
  203.  
  204.  
  205.          Warranty and copyright
  206.  
  207.  
  208. Copyleft
  209.  
  210. Source code that is not part of the MiscKit project - and therefore
  211. underlies the MiscKit distribution and copyright rules - is
  212. distributed under the GNUpublic license.
  213.  
  214.  
  215. No Warranty
  216.  
  217. This software is provided 'as is' and the programmer is not
  218. responsible for any harm this program may cause. You - the user - are
  219. responsible for everything that may happen to your business,
  220. hardware, software, car, CD collection or what ever may be worth your
  221. attention or money. Using this product is at your own risk and
  222. your private fun.
  223.  
  224. There should be no serious bugs inside but remember that a
  225. carbon-based unit did the coding.
  226.  
  227.  
  228. TravelWare
  229.  
  230. Like all my projects this app is free and should be considered as
  231. travel-ware.
  232.  
  233.  1. Let it travel to as many people as you know. 
  234.  
  235.  2. Send me a postcard or E-mail if you use it. I will try to
  236.     keep you informed about new releases.
  237.  
  238.  3. If you have a free bed or some free space on your floor... give
  239.     me a hint. I might come and visit you on my trip to the US 
  240.     (locations on Hawaii, near Seattle or WhistlerMnt. (Canada) 
  241.     preferred)
  242.  
  243.  
  244.  
  245.          Credits
  246.  
  247.  
  248.  -  The guys at NeXT for this amazing OS + development tools.
  249.     This was my first NeXTSTEP/Obj-C application and the code was
  250.     written within 76 days (see the Release Notes). I would have never 
  251.     believed that this was possible. And it was fun too.
  252.  
  253.  -  Steve Ludtke for the 3DKit code inside MolViewer that gave me
  254.     a quick start. Although I don't find his code very readable...but it
  255.     works.
  256.  
  257.  -  Greg Burd's swapView saved me a lot of time and helped me
  258.     with all the swapping. But it needed a complete rewrite to meet the
  259.     apps needs.
  260.  
  261.  -  Mike Ferris for the MOKit. Very nice and useful objects for
  262.     everybody. His String object helped me to get going. But now it
  263.     merged with the MiscKit and so I'm not using his good kit anymore
  264.  
  265.  -  H. Scott Roy for the IconKit. A very well designed object
  266.     collection for the basic drag&drop stuff. You can find it on every
  267.     NeXTSTEP ftp site.
  268.  
  269.  -  Georg Tuparev for providing access to NeXTSTEP for HP and Sparc, at the
  270.     EMBL-Heidelberg. 
  271.  
  272.  -  Everybody writing nice objects like the guys from the MiscKit
  273.     (Don don't get tired of keeping it all together. Misc is cool)
  274.  
  275.  -  My brother for all the nice images and chemistry background
  276.     info I might not remember in detail anymore.
  277.  
  278.  
  279.  
  280. Enjoy it.
  281.  
  282.            Tomi
  283.