Skip to content

Latest commit

 

History

History
135 lines (100 loc) · 4.83 KB

INSTALL.md

File metadata and controls

135 lines (100 loc) · 4.83 KB

Prerequisites

Because the models are distributed only as source, there are a few prerequisites needed before you can build and use the model. Namely:

  • A working C compiler: Since the models is written in C, you'll need something to compile it.
  • Gnu Make

If you already have these on your machine, skip down to the section Compiling

Setting up Mac OS X

  1. To get a C compiler and Make for OS X, you will need to obtain Apple's software development tool Xcode. Included with Xcode are the compilers needed to build DEBaM and DETIM.
  • The easiest way to obtain Xcode is via the App Store. It's pretty big, so do this somewhere with a fast internet connection.
  • Once it's downloaded, open Xcode from your Applications folder. Follow the instructions asked by the dialog boxes.
  • After Xcode has finished installing, one further step is needed to install the command-line tools:
    • Open the menu Xcode > Preferences
    • Open the Downloads tab in the Preferences
    • In the Downloads list, select Command Line Tools, and push the install button
  1. You're done!

Setting up Linux

This is perhaps the easiest situation in which you could find yourself, not least because you probably already have everything you need.

Many distros come packaged with a C compiler and Make, but a notable few don't. If you have the following, run the commands below at the command line

  • Ubuntu/Debian:

      $ apt-get install build-essential

  • Fedora:

      $ yum install make automake gcc gcc-c++

  • Arch:

      $ pacman -S base-devel

Setting up Windows

On Windows, we have had success getting DEBaM and DETIM running using Cygwin, a Linux-like system for Windows.

Each of the following instructions roughly corresponds to a single dialog window of Cygwin's installer.

  1. Download and run Cygwin's setup.exe installer; this will install Cygwin, as well as the compiler gcc an Make.
  2. Click "Next" at the first prompt.
  3. When prompted to "Choose A Download Source" select "Install from Internet"
  4. Choose your Root Install Directory: unless you are really sure, leave this set to the default.
  5. Ditto for "Select Local Package Repository"
  6. Under "Select Connection Type", let Cygwin know how to connect to the internet (usually "Direct Connection").
  7. Under "Select a Mirror" it's fine to do nothing here. If your download speeds really crawl, you can cancel the installation and change this.
  8. Under "Select Packages" expand the "Devel" section by clicking on the "+" sign in the box.
  • Select gcc, and make.

  1. Click "Next" and follow the remaining installation instructions.

  2. Open Cygwin by either clicking the icon on your desktop, or via the Start Menu. Cygwin will present itself as command prompt window.

  3. Proceed as below in the Compiling section.

Compiling

Getting The Source

Now you'll need to get a copy of the source code (We suggest you download the version release-0.2). The models are hosted from our github repository. You can download the source as zip or tar files via:

Alternately, you can also clone the project with Git by running (command line in terminal):

$ git clone https://github.com/regine/meltmodel.git

from a terminal. If you plan to contribute to the project, you should use git, and spend some time getting familiar with it. More information about git can be found at git-scm or at Github.

Compiling

Open up a command-line window and navigate to the folder containing the model source files.

At the command prompt, do

$ cd meltmodel
$ make models

The model executables will now be located in meltmodel/bin.

The Makefile provides several different build targets, for those who only wish to build parts of the project. These targets are built by running make <target_name> at the command line, where <target_name> is one of the following:

  • debam or detim: Either of these builds only the model
  • models: builds both models
  • ascigrid or gridasci or gridtools: ascigrid and gridasci build the individual executables, grid tools builds both
  • shading: builds the shading tool
  • utils: builds both shading and the grid tools
  • all: builds everything
  • clean: deletes all built executables and intermediate build products.

For information regarding running the model, please consult the manual, located at Regine Hock's page.