Skip to content

Commit

Permalink
more updates to src installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeeman committed Nov 11, 2014
1 parent 73035d5 commit 7e398b4
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 43 deletions.
13 changes: 7 additions & 6 deletions src/Makefile.dist
Original file line number Diff line number Diff line change
Expand Up @@ -948,10 +948,10 @@ SPRNGLIB = $(SPRNGDIR)/lib/lib$(SPRNG_LIB).a
# ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~

## This configuration was originally provided by a GENESIS user,
## Alfonso Delgado-Reyes. For this GENESIS 2.4 release, we would
## Alfonso Delgado-Reyes. For this GENESIS 2.4 release, Boris Marin
## and Jan Pieczkowski updated it for Mac OSX > 10.8. We would
## appreciate comments and feedback from other users of recent
## versions of MacOS , and the upcoming Yosemite release, in
## particular.
## versions of MacOS via the genesis-sim-users mailing list.
##
## If compilation fails because of errors in netcdf, see the earlier
## comments on changing the definitions for the netCDF file format, in
Expand Down Expand Up @@ -1131,7 +1131,7 @@ SPRNGLIB = $(SPRNGDIR)/lib/lib$(SPRNG_LIB).a
# end IBM RS6000 running AIX

# ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
# System: Cygwin
# System: Cygwin (32 bit version)
# Compiler: gcc
# ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~

Expand All @@ -1144,10 +1144,11 @@ SPRNGLIB = $(SPRNGDIR)/lib/lib$(SPRNG_LIB).a

#MACHINE=Cygwin

## This may need to be BSD
#OS=SYSV

#XINCLUDE=-I/usr/include
#XLIB=/usr/X11R6/lib
#XINCLUDE=-I/usr/include/X11
#XLIB=/usr/lib

#CC=gcc
#CPP=cpp -P
Expand Down
66 changes: 34 additions & 32 deletions src/README.OSX
Original file line number Diff line number Diff line change
@@ -1,38 +1,40 @@
README.OSX

RUNNING GENESIS
The __binary__ distribution of GENESIS will only work with OSX 10.2 and higher,
on the PowerPC architecture. You'll have to compile the package from source
to run on earlier versions or on the Intel.

The non-graphical version of GENESIS (nxgenesis) should run on any standard
OSX installation. Graphical GENESIS (genesis) relies on the X11 libraries for
it's graphical user interface (GUI). An X11 server needs to be started before
graphical GENESIS can be run. If you can't locate the X11 application (usually
Applications->Utilities->X11), see:
http://developer.apple.com/darwin/runningX11.html
for further information.

Starting the X11 application should bring up an 'xterm' window. Graphical
GENESIS must be started from the xterm window; it will not work from a window
started by the 'Terminal' application.

If a binary distribution of GENESIS for Mac OSX is available, it
may be unpacked from the 'genesis-2.4-<os>-bin.tar.gz' archive,
following the intructions in genesis/README.bindist. Otherwise, it may be
compiled from the instructions in genesis/src/README.txt and in this file.

The non-graphical version of GENESIS (nxgenesis) should run on any
standard OSX installation. Graphical GENESIS (genesis) relies on the
X11 libraries for it's graphical user interface (GUI). An X11 server
needs to be started before graphical GENESIS can be run. If you can't
locate the X11 application (perhaps in Applications->Utilities->X11),
see: https://developer.apple.com/opensource/ or the XQuartz project
(http://xquartz.macosforge.org/landing/).

Starting the X11 application should bring up a console window. Graphical
GENESIS must be started from the console window; it will not work from a window
started by the 'Terminal' application.

BUILDING GENESIS
To compile GENESIS under OSX, you will first need a compiler. One may already
be installed. Check by running 'which cc' from any terminal window. If something
like '/usr/bin/cc' is returned, continue to the next paragraph. If cc was not
found, you probably need to install the Xcode development tools. More
information on installing the Xcode tools as well as some links to basic
navigation through the underlying Unix layer of OSX can be found at:
http://www.macworld.com/weblogs/macosxhints/2005/08/installxcode/index.php
(Please let us know if this link becomes broken)

In order to compile and run GENESIS graphically (i.e., not just from the
command line), the X11 Software Development Kit (SDK) must be installed.
If you've followed the instructions from the link above, it should get
installed. If you already had a compiler and tried compiling GENESIS, but got
lots of errors about "X11/somefile.h not found", then the X11 SDK is probably
not installed. The X11 SDK will be available on your OSX installation CD or the
Xcode image you downloaded from Apple's developer website. For more information,
see: http://developer.apple.com/darwin/runningX11.html

To compile GENESIS under OSX, you will first need a compiler. One may
already be installed. Check by running 'which cc' from any terminal
window. If something like '/usr/bin/cc' is returned, continue to the
next paragraph. If cc was not found, you probably need to install the
development tools. The default compiler on recent Mac OS versions is
clang, but GNU gcc is a safer choice. GENESIS has been verified to
compile correctly with gcc-4.8 and 4.9, and clang-600.0.54. gcc can
be installed via homebrew (http://brew.sh/):

brew install https://raw.github.com/Homebrew/homebrew-versions/gcc48.rb

Flex and Bison are required, and can be installed via

brew install flex bison

Then, you should be able to install GENESIS with "configure", as described
in genesis/src/README.txt. Otherwise, see the section "Compiling with Mac OS X".
29 changes: 24 additions & 5 deletions src/README.cygwin
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,32 @@ README.Cygwin

Cygwin provides a UNIX-like environment for Windows that will let you run
GENESIS and other UNIX programs that have been compiled to run under Cygwin.
Go to http://cygwin.com, and look for the "Install Cygwin now" link. This
will download a small setup.exe, which will let you choose what to install and
then download it. For more information about selecting packages to install,
use the link for "Help on setup.exe". For more information on Cygwin, see
the Cygwin users guide at http://cygwin.com/cygwin-ug-net/

Go to http://cygwin.com, and install it by downloading and running
setup-x86.exe (32-bit installation). This may be used with 64 bit MS Windows,
and is recommended over the less stable setup-x86_64.exe.

Running this will let you choose what to install and then download it.

When using Cygwin Setup for the first time, the default is to install
a minimal subset of all available packages. If you want anything
beyond that, you will have to select it explicitly. See
http://cygwin.com/packages/ for a searchable list of available
packages, or use cygcheck -p as described in the Cygwin User's Guide
at http://cygwin.com/cygwin-ug-net/using-utils.html#cygcheck.

If you need to build GENESIS from source, you will need gcc, binutils,
make and probably other packages from the ``Devel'' category. Text
editors can be found under ``Editors''. For more information about
selecting packages to install, and using Cygwin, consult the
docmentation links at http://cygwin.com.

More information on installing and using X windows with Cygwin can be found
at http://x.cygwin.com/.


RUNNING GENESIS

GENESIS can be run under Windows with the Cygwin software installed. If you want
to run GENESIS with GUI capabilities, the X windows package must be installed
under Cygwin. The instructions below assume you want GUI capabilities. You
Expand Down

0 comments on commit 7e398b4

Please sign in to comment.