README

   1 ========================================================
   2
   3                      Molby
   4
   5     An Interactive Molecular Modeling Software
   6         with Integrated Ruby Interpreter
   7
   8           Version 0.5.3 build 20100425
   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-2010 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 - AmberTools 1.3: Copyright (c) Junmei Wang, Ross C. Walker, Michael F. Crowley, Scott Brozell and David A. Case
  40
  41 Molby is distributed under the GNU General Public License (version 2). See the file COPYING for more details.
  42
  43 4. How to Use
  44
  45 The document in HTML format is available. Try the tutorial to get familiar with Molby.
  46
  47 5. How to Build
  48
  49 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.
  50
  51 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.
  52
  53 (1) Mac OS X
  54
  55 (i) Xcode
  56
  57 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.
  58
  59 (ii) wxWidgets
  60
  61 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.
  62
  63 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:
  64 $ mkdir -p $HOME/Development
  65 $ cd $HOME/Development
  66 $ mv somewhere/wxMac-2.8.9.tar.gz ./
  67 $ tar xvzf wxMac-2.8.9.tar.gz
  68 $ ln -s wxMac-2.8.9 wxMac
  69
  70 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.
  71
  72 Build wxMac. The commands will be as follows. Take care of the configure options.
  73 $ cd $HOME/Development/wxMac
  74 $ mkdir osx-build
  75 $ cd osx-build
  76 $ ../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
  77 $ make
  78 (You do not need to do "sudo make install".)
  79
  80 (iii) Ruby
  81
  82 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).
  83 $ cd $HOME/Development
  84 $ mv somewhere/ruby-1.8.7-p160.tar.gz ./
  85 $ tar xvzf ruby-1.8.7-p160.tar.gz
  86 $ ln -s ruby-1.8.7-p160 ruby-1.8.7-static
  87
  88 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.
  89
  90 Patch the Ruby source.
  91 $ cd $HOME/Development/ruby-1.8.7-static
  92 $ patch --backup -p1 < $MOLBY/ruby-1.8.7-p160-tn.patch
  93 ($MOLBY is the location of the Molby source.)
  94
  95 Build Ruby with --disable-shared option.
  96 $ CFLAGS='-isysroot /Developer/SDKs/MacOSX10.4u.sdk -mmacosx-version-min=10.4 -arch i386 -arch ppc -O2' ./configure --disable-shared --disable-thread
  97 $ make
  98
  99 (iv) Build on Xcode
 100
 101 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.
 102
 103 (2) Windows
 104
 105 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!
 106
 107 (i) MinGW and MSYS
 108
 109 Install MinGW and MSYS. The default configuration should be sufficient.
 110
 111 (ii) wxWidgets
 112
 113 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.
 114
 115 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:
 116 $ cd $HOME
 117 $ mv somewhere/wxMSW-2.8.9.tar.gz ./
 118 $ tar xvzf wxMSW-2.8.9.tar.gz
 119
 120 Build wxMSW. The commands will be as follows. Take care of the configure options.
 121 $ cd $HOME/wxMSW-2.8.9
 122 $ mkdir msw-build
 123 $ cd msw-build
 124 $ ../configure --with-msw --with-opengl --disable-shared --enable-unicode --with-libjpeg-builtin --with-zlib=builtin
 125 $ make
 126 (You do not need to do "sudo make install".)
 127
 128 (iii) Ruby
 129
 130 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.
 131 $ cd $HOME
 132 $ mv somewhere/ruby-1.8.7-p160.tar.gz ./
 133 $ tar xvzf ruby-1.8.7-p160.tar.gz
 134 $ mv ruby-1.8.7-p160 ruby-1.8.7-static
 135
 136 Patch the Ruby source.
 137 $ cd $HOME/ruby-1.8.7-static
 138 $ patch --backup -p1 < $MOLBY/ruby-1.8.7-p160-tn.patch
 139 ($MOLBY is the location of the Molby source.)
 140
 141 Build Ruby with --disable-shared option.
 142 $ ./configure --disable-shared --disable-thread
 143 $ make
 144
 145 (iv) CLAPACK
 146
 147 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.)
 148 $ cd $HOME
 149 $ mv somewhere/clapack-3.1.1.1.tgz ./
 150 $ tar xvzf clapack-3.1.1.1.tgz
 151
 152 Patch the clapack source.
 153 $ patch -p0 <$MOLBY/clapack-3.1.1.1-mingw.patch
 154
 155 Build CLAPACK.
 156 $ cd CLAPACK-3.1.1.1
 157 $ make
 158
 159 Modify libf2c.a, so that the 'main' entry does not interfere the main program.
 160 $ cd F2CLIBS
 161 $ cp libf2c.a libf2c_nomain.a
 162 $ ar d libf2c_nomain.a main.o
 163 $ cd ..
 164
 165 Copy the library and header files to /lib/clapack.
 166 $ mkdir /lib/clapack
 167 $ cp F2CLIBS/libf2c_nomain.a /lib/clapack
 168 $ cp blasMinGW.a /lib/clapack/libblas.a
 169 $ cp lapackMinGW.a /lib/clapack/liblapack.a
 170 $ cp INCLUDE/f2c.h INCLUDE/blaswrap.h INCLUDE/clapack.h /lib/clapack
 171
 172 (v) Inno Setup 5
 173
 174 Install Inno Setup 5 (http://www.jrsoftware.org/isinfo.php). This is necessary to create the Molby Installer.
 175
 176 (vi) Build
 177
 178 Now you can start building Molby! Go to the project directory and do make.
 179 $ cd somewhere/Molby/msw-build
 180 $ make
 181 $ make setup  #  To make the installer
 182
 183
 184 2010.1.21.
 185 2010.1.31. Added notice on AmberTools1.3
 186
 187 Toshi Nagata