Difference between revisions of "Installing"
m (→Downloading the source) |
|||
| (23 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
==Installing the program== | ==Installing the program== | ||
| − | '''The program requires ImageMagick for writing images and bzip2 for compressing data files.''' | + | '''The program requires ImageMagick for writing images and bzip2 for compressing data files.''' We recommenced using [http://macports.org macports] to install ImageMagick on OS X, and [http://cygwin.org cygwin] to install ImageMagick and bzip2 on windows ([[Installing#Platform_Specific_Information|see 'Platform Specific Information' below]]). |
| + | ===Precompiled binary for OS X=== | ||
| − | + | We provide a [http://www.dayel.com/comet/bin/ precompiled binary for Mac OS X], and instructions for compiling from source for OS X, Linux and Windows. The precompiled OS X binary includes the VTK 3D visualization and GSL random number generator, but still requires ImageMagick for the bitmap conversion. | |
| − | + | ||
| − | We provide a [http:// | + | |
===Compiling from source=== | ===Compiling from source=== | ||
| Line 12: | Line 11: | ||
====Downloading the source==== | ====Downloading the source==== | ||
| − | The source is available via | + | The source is freely available via [http://git-scm.com/ git] under the open source GNU General Public License. You can download a [http://github.com/markdayel/comet/archives/master zipped copy of the latest source here]. You can [http://github.com/markdayel/comet/ browse the source repository at github] or to create your own local git repository of the source, by installing git then typing: |
| − | + | git clone git://github.com/markdayel/comet.git | |
| + | |||
| + | ====Compiling==== | ||
| + | |||
| + | Makefiles are included for building with GCC on linux, OS X, windows, and DEC Alpha, and an Xcode project file is also included for OS X. If you are unfamiliar with git, there is a lot if information online---I found [http://www.gitready.com/ this website] a useful place to start. | ||
| + | |||
| + | ====VTK and GSL Dependencies==== | ||
| + | |||
| + | The code has two optional dependencies, the [http://www.gnu.org/software/gsl/ Gnu Scientific Library (GSL)] which provides the Mersenne Twister random number generator (more statistically valid than the standard rand() function), and [http://vtk.org The Visualization Toolkit (VTK)] which provides the 3D visualization routines. I have posted precompiled binary versions of the [http://www.dayel.com/2009/09/installing-vtk-on-os-x/ VTK] and [http://www.dayel.com/2009/09/building-gsl-universal-binary/ GSL] libraries for OS X, which you should be able to use directly just by unzipping the files and setting the paths in Xcode or the makefile to point to the include files and libraries. | ||
| + | |||
| + | =====Compiling without GSL or VTK===== | ||
| + | If the libraries are not available, you can compile without them by changing the #define's USE_GSL_RANDOM and LINK_VTK in the file stdafx.h from 1 to 0 respectively. | ||
| − | == | + | ==Platform Specific Information== |
| − | The code has | + | The code has been developed on OS X 10.5 and Linux, but should run fine in windows. |
====OS X==== | ====OS X==== | ||
| − | First install the [http://developer.apple.com/tools/ Apple Developer Tools], then open the Xcode | + | First install the [http://developer.apple.com/tools/ Apple Developer Tools], then open the Xcode project file included in the source. Include the GSL and VTK libraries in the search path, or disable before compiling (see above). |
====Linux==== | ====Linux==== | ||
| − | A makefile is included for compilation with GNU Make. This should be edited to point to the GSL and VTK libraries, or disable them before compiling (see above). | + | A makefile is included for compilation with GNU Make. This should be edited to point to the GSL and VTK libraries, or disable them before compiling (see above). To install GSL on ubuntu type |
| + | sudo apt-get install libgsl0-dev | ||
====Windows==== | ====Windows==== | ||
| − | First install [http://cygwin.org cygwin], then use cygwin to install ImageMagick, bzip2 and gcc, then compile as for Linux. | + | First install [http://cygwin.org cygwin], then use cygwin to install ImageMagick, bzip2 and gcc, then compile as for Linux. If compiling with Visual Studio instead of gcc, you will also need a pthreads library. |
Latest revision as of 10:19, 7 November 2009
Contents
Installing the program
The program requires ImageMagick for writing images and bzip2 for compressing data files. We recommenced using macports to install ImageMagick on OS X, and cygwin to install ImageMagick and bzip2 on windows (see 'Platform Specific Information' below).
Precompiled binary for OS X
We provide a precompiled binary for Mac OS X, and instructions for compiling from source for OS X, Linux and Windows. The precompiled OS X binary includes the VTK 3D visualization and GSL random number generator, but still requires ImageMagick for the bitmap conversion.
Compiling from source
Downloading the source
The source is freely available via git under the open source GNU General Public License. You can download a zipped copy of the latest source here. You can browse the source repository at github or to create your own local git repository of the source, by installing git then typing:
git clone git://github.com/markdayel/comet.git
Compiling
Makefiles are included for building with GCC on linux, OS X, windows, and DEC Alpha, and an Xcode project file is also included for OS X. If you are unfamiliar with git, there is a lot if information online---I found this website a useful place to start.
VTK and GSL Dependencies
The code has two optional dependencies, the Gnu Scientific Library (GSL) which provides the Mersenne Twister random number generator (more statistically valid than the standard rand() function), and The Visualization Toolkit (VTK) which provides the 3D visualization routines. I have posted precompiled binary versions of the VTK and GSL libraries for OS X, which you should be able to use directly just by unzipping the files and setting the paths in Xcode or the makefile to point to the include files and libraries.
Compiling without GSL or VTK
If the libraries are not available, you can compile without them by changing the #define's USE_GSL_RANDOM and LINK_VTK in the file stdafx.h from 1 to 0 respectively.
Platform Specific Information
The code has been developed on OS X 10.5 and Linux, but should run fine in windows.
OS X
First install the Apple Developer Tools, then open the Xcode project file included in the source. Include the GSL and VTK libraries in the search path, or disable before compiling (see above).
Linux
A makefile is included for compilation with GNU Make. This should be edited to point to the GSL and VTK libraries, or disable them before compiling (see above). To install GSL on ubuntu type
sudo apt-get install libgsl0-dev
Windows
First install cygwin, then use cygwin to install ImageMagick, bzip2 and gcc, then compile as for Linux. If compiling with Visual Studio instead of gcc, you will also need a pthreads library.
