README

   1 ========================================================
   2
   3                      Molby
   4
   5     An Interactive Molecular Modeling Software
   6         with Integrated Ruby Interpreter
   7
   8           Version 0.5.0 build 20100121
   9
  10                   Toshi Nagata
  11
  12 ========================================================
  13
  14 1. What is it?
  15
  16 Molby is an application to visualize and build molecular models interactively through 3D display. It provides the following capability:
  17
  18 - Viewing molecular models in either ball-and-stick or "line" display.
  19 - Interactive modification of molecular models by mouse operation.
  20 - Viewing and editing atomic coordinates and other parameters in numeric tables.
  21 - Importing and exporting structure/coordinate data for other program packages such as Gaussian, GAMESS, NAMD and SHELX.
  22 - Embedded Ruby interpreter for automated processing of molecular models.
  23
  24 2. Supported Platforms
  25
  26 Molby runs on Mac OS X (10.4 and later) and Microsoft Windows (XP and later). Executable binaries are provided for both platforms (Molby.dmg for Mac, SetupMolby.exe for Windows).
  27
  28 3. Copyright and License
  29
  30 Molby is a copyrighted product of Toshi Nagata.
  31
  32        Copyright (C) 2009 Toshi Nagata
  33
  34 Molby includes (more technically: is statically linked to) the following softwares, which are copyrighted products as described below:
  35
  36 - wxWidgets 2.8.9: Copyright (C) 1992-2008 Julian Smart, Robert Roebling, Vadim Zeitlin and other members of the wxWidgets team. Portions (c) 1996 Artificial Intelligence Applications Institute
  37 - Ruby 1.8.7: Copyright (C) 1993-2009 Yukihiro Matsumoto
  38 - CLAPACK: Copyright (c) 1992-2008 The University of Tennessee.
  39
  40 Molby is distributed under the GNU General Public License (version 2). See the file COPYING for more details.
  41
  42 4. How to Use
  43
  44 The document in HTML format is available. Try the tutorial to get familiar with Molby.
  45
  46 5. How to Build
  47
  48 The information in this section is only for those who want to build Molby from the source. If you use the binary distribution, you do not need to read this section.
  49
  50 Building Molby is somewhat complicated because you need static libraries of wxWidgets and Ruby (and CLAPACK in Windows). The procedures are described below for each platform.
  51
  52 (1) Mac OS X
  53
  54 (i) Xcode
  55
  56 Install Xcode, if you have not done so yet. The Xcode project included in the source distribution is for Xcode 3.0 and later, thus you need Mac OS 10.5. It may work with Xcode 2.5 on Mac OS 10.4, but this have not been tested.
  57
  58 (ii) wxWidgets
  59
  60 Get wxMac-2.8.9.tar.gz from the wxWidgets page in sourceforge.net (http://sourceforge.net/projects/wxwindows/files/). Newer versions may work, but they are not tested.
  61
  62 Unpack wxMac-2.8.9.tar.gz. Move the resulting directory wxMac-2.8.9 to $HOME/Development, and rename it to wxMac (or make a symbolic link). The console commands will be as follows:
  63 $ mkdir -p $HOME/Development
  64 $ cd $HOME/Development
  65 $ mv somewhere/wxMac-2.8.9.tar.gz ./
  66 $ tar xvzf wxMac-2.8.9.tar.gz
  67 $ ln -s wxMac-2.8.9 wxMac
  68
  69 If you want to place wxMac in another place (and/or another name) than $HOME/Development, you will need to change the build settings in Xcode.
  70
  71 Build wxMac. The commands will be as follows. Take care of the configure options.
  72 $ cd $HOME/Development/wxMac
  73 $ mkdir osx-build
  74 $ cd osx-build
  75 $ ../configure --with-macos-sdk=/Developer/SDKs/MacOSX10.4u.sdk --with-macosx-version-min=10.4 --enable-universal_binary --disable-shared --with-opengl --enable-unicode --with-libjpeg=builtin --with-libpng=builtin --with-regex=builtin --with-libtiff=builtin --with-zlib=builtin --with-expat=builtin
  76 $ make
  77 (You do not need to do "sudo make install".)
  78
  79 (iii) Ruby
  80
  81 Get ruby-1.8.7-p160.tar.gz from the Molby source distribution site. Unpack it, and move the resulting directory ruby-1.8.7-p160 to $HOME/Development. Rename it to ruby-1.8.7-static (or make a symbolic link).
  82 $ cd $HOME/Development
  83 $ mv somewhere/ruby-1.8.7-p160.tar.gz ./
  84 $ tar xvzf ruby-1.8.7-p160.tar.gz
  85 $ ln -s ruby-1.8.7-p160 ruby-1.8.7-static
  86
  87 If you want to place ruby-1.8.7-static in another place (and/or another name) than $HOME/Development, you will need to change the build settings in Xcode.
  88
  89 Patch the Ruby source.
  90 $ cd $HOME/Development/ruby-1.8.7-static
  91 $ patch --backup -p1 < $MOLBY/ruby-1.8.7-p160-tn.patch
  92 ($MOLBY is the location of the Molby source.)
  93
  94 Build Ruby with --disable-shared option.
  95 $ CFLAGS='-isysroot /Developer/SDKs/MacOSX10.4u.sdk -mmacosx-version-min=10.4 -arch i386 -arch ppc -O2' ./configure --disable-shared --disable-thread
  96 $ make
  97
  98 (iv) Build on Xcode
  99
 100 Open xcode-build/Molby.xcodeproj, and build. Note that there are two configurations, Debug and Release. In the "Release" build, the Ruby scripts update_version.rb and Documents/makedoc.rb are executed before compilation; update_version.rb modifies the version strings in the source files (by looking up the file Version), and makedoc.rb creates the HTML docments in the doc directory.
 101
 102 (2) Windows
 103
 104 The Windows binary is built by using MinGW/MSYS. If you use VC++ or Cygwin, you need to help yourself. I use Windows only occasionally, so there may be errors and misunderstandings in the following descriptions. Feedback is welcome!
 105
 106 (i) MinGW and MSYS
 107
 108 Install MinGW and MSYS. The default configuration should be sufficient.
 109
 110 (ii) wxWidgets
 111
 112 Get wxMSW-2.8.9.tar.gz from the wxWidgets page in sourceforge.net (http://sourceforge.net/projects/wxwindows/files/). Newer versions may work, but they are not tested.
 113
 114 Unpack wxMSW-2.8.9.tar.gz. Move the resulting directory wxMSW-2.8.9 to $HOME (the home directory of the MinGW The console commands will be as follows:
 115 $ cd $HOME
 116 $ mv somewhere/wxMSW-2.8.9.tar.gz ./
 117 $ tar xvzf wxMSW-2.8.9.tar.gz
 118
 119 Build wxMSW. The commands will be as follows. Take care of the configure options.
 120 $ cd $HOME/wxMSW-2.8.9
 121 $ mkdir msw-build
 122 $ cd msw-build
 123 $ ../configure --with-msw --with-opengl --disable-shared --enable-unicode --with-libjpeg-builtin --with-zlib=builtin
 124 $ make
 125 (You do not need to do "sudo make install".)
 126
 127 (iii) Ruby
 128
 129 Get ruby-1.8.7-p160.tar.gz from the Molby source distribution site. Unpack it, and move the resulting directory ruby-1.8.7-p160 to $HOME. Rename it to ruby-1.8.7-static.
 130 $ cd $HOME
 131 $ mv somewhere/ruby-1.8.7-p160.tar.gz ./
 132 $ tar xvzf ruby-1.8.7-p160.tar.gz
 133 $ mv ruby-1.8.7-p160 ruby-1.8.7-static
 134
 135 Patch the Ruby source.
 136 $ cd $HOME/ruby-1.8.7-static
 137 $ patch --backup -p1 < $MOLBY/ruby-1.8.7-p160-tn.patch
 138 ($MOLBY is the location of the Molby source.)
 139
 140 Build Ruby with --disable-shared option.
 141 $ ./configure --disable-shared --disable-thread
 142 $ make
 143
 144 (iv) CLAPACK
 145
 146 Get clapack-3.1.1.1.tar.gz from the CLAPACK official site (http://www.netlib.org/clapack/) and unpack it. (clapack-3.2.1 may cause trouble because it uses symbolic links.)
 147 $ cd $HOME
 148 $ mv somewhere/clapack-3.1.1.1.tgz ./
 149 $ tar xvzf clapack-3.1.1.1.tgz
 150
 151 Patch the clapack source.
 152 $ patch -p0 <$MOLBY/clapack-3.1.1.1-mingw.patch
 153
 154 Build CLAPACK.
 155 $ cd CLAPACK-3.1.1.1
 156 $ make
 157
 158 Modify libf2c.a, so that the 'main' entry does not interfere the main program.
 159 $ cd F2CLIBS
 160 $ cp libf2c.a libf2c_nomain.a
 161 $ ar d libf2c_nomain.a main.o
 162 $ cd ..
 163
 164 Copy the library and header files to /lib/clapack.
 165 $ mkdir /lib/clapack
 166 $ cp F2CLIBS/libf2c_nomain.a /lib/clapack
 167 $ cp blasMinGW.a /lib/clapack/libblas.a
 168 $ cp lapackMinGW.a /lib/clapack/liblapack.a
 169 $ cp INCLUDE/f2c.h INCLUDE/blaswrap.h INCLUDE/clapack.h /lib/clapack
 170
 171 (v) Inno Setup 5
 172
 173 Install Inno Setup 5 (http://www.jrsoftware.org/isinfo.php). This is necessary to create the Molby Installer.
 174
 175 (vi) Build
 176
 177 Now you can start building Molby! Go to the project directory and do make.
 178 $ cd somewhere/Molby/msw-build
 179 $ make
 180 $ make setup  #  To make the installer
 181
 182
 183 2010.1.21.
 184 Toshi Nagata