# Copyright (C) 2001-2011 Association of Universities for Research in Astronomy, Inc. ##*********************************************************************** ## ## FILENAME ## INSTALL.TXT ## ## PURPOSE: ## Instructions on how to install Gemini Mask Making Prototype Software (GMMPS). ## ## INSTALLATION INSTRUCTIONS FOR GEMINI GMMPS PACKAGE --- Binary Release Installation Instructions --- Pre-compiled binary releases of are available for the following platforms: Mac (Intel and PowerPC) Fedora Core 3 Fedora Core 4 Fedora Core 6 Fedora Core 14 32/64 bit Ubuntu 10.04 32/64 bit RedHat 9 Redhat Enterprise 5.5 32/64 bit If you use another Linux distribution then you need to figure out which build your version/distribution of Linux will be compatible with. E.g. the following distributions are compatible with the given binary set: Debian 2.6.8 ---> Fedora3 openSUSE 10.2 ---> Fedora3 RedHat Enterprise 2.6 ---> RedHat9 Ubuntu 9 ---> RedHat5.5 If in doubt, try RedHat5.5. If none of the provided binaries are compatible then you will need to compile your own version of GMMPS using the instructions below. 0) Install Skycat To run GMMPS Skycat must be installed. GMMPS Version 0.304 was designed and tested for use with Skycat 3.1.1 (Linux) or Skycat 3.0.1 (Mac) for the most reliable results it is recommended that you use these Skycat versions. You can download Skycat at: http://archive.eso.org/cms/tools-documentation/eso-skycat-download NOTE FOR LINUX USERS: The skycat binary must be in your shell's path. This is normally the case for skycat version 3.1.1 (it is in /usr/local/bin). If typing 'skycat' in the terminal does not start start skycat, you may need to add skycat to your shell's path before you can run GMMPS. There are instructions on how to add something to your path (for Bash) in step 3. NOTE for Ubuntu and other Debian-based systems: 64-bit Linux systems require skycat 3.1.1 and associated Tcl/Tk packages. The binaries are only distributed as rpms. In order to install these on a Debian-based system (eg. Ubuntu) they must be converted to a deb package using alien. For example: sudo apt-get update sudo apt-get install alien sudo alien -k --scripts skycat-3.1.1-1.x86_64.rpm sudo dpkg -i skycat_3.1.1-1_amd64.deb sudo alien -k tcltk-8.4-2.x86_64.rpm sudo dpkg -i tcltk_8.4-2_amd64.deb 1) Untar the distribution tarfile. tar xvzf gmmps-0.304-REL.tar.gz This tarfile unpacks to a directory named gmmps-0.304-REL located in your current working directory. 2) Run installation script. In your terminal run: /gmmps-0.304-REL/install This will create the /gmmps-0.304-REL/bin/gmmps startup script. If you need to override the platform selected by the install script or your platform is not one of those supplied then you may specify the platform: e.g. to set the platform for Debian 2.6.8 you would run /gmmps-0.304-REL/install Fedora3 3) Add gmmps to your path. While it is possible to run GMMPS by running the /gmmps-0.304-REL/bin/gmmps script directly, it is better if you add gmmps' bin directory to your path. The installation script provide the /gmmps-0.304-REL/bin directory that needs to be added to your shell's PATH environmental variable. NOTE: If there is another version of GMMPS already installed on your machine then you either need to rename it or remove reference to that version from your path variable. --FOR BASH-- ( the default Mac terminal shell ) In Bash this file is called ".bashrc" in linux and ".profile" in mac, and is located in your home directory. It is a hidden file that is most easily opened via the terminal. To open your .bashrc or .profile file navigate to your home directory and type: gedit .bashrc (Linux) (gedit may not be installed on your system, if it isn't you can try "vi .bashrc" or "emacs .bashrc") or open .profile (Mac) If you see a line in your configuration file that looks like: export PATH=/usr/local/bin:/bin:$PATH you should edit it to look like export PATH=/usr/local/bin:/bin:/gmmps-0.304-REL/bin:$PATH If the file is empty or you do not see PATH defined in this way you should add the following line to the end of the file (substituting with it's appropriate value): export PATH=/gmmps-0.304-REL/bin:$PATH 4.) Restart Shell and run gmmps. You can must now restart your shell (by closing the terminal window and reopening it). After restarting your shell you can type 'gmmps' into your terminal window, and gmmps should start. END OF BINARY RELEASE INSTALLATION INSTRUCTIONS. ---Source Code Installation Instructions--- Use these instructions if you are attempting to compile GMMPS for a system not supported in a binary release. Mac users and those running supported Linux distributions can follow the much simpler and more reliable "Binary Release Installation Instructions" above. If you are planning to run under Mac or a supported Linux platform, you should not compile the software, binaries are distributed for these architectures. Warning: while you the package contains most of what you need to compile (you will also need Skycat), there are manual steps below which must be followed in order to build. 1) De-tar the distribution tarfile tar xvf gmmps-.tar The tarfile unpacks to a directory named gmmps- 2) Build cfitsio starting in the gmmps package directory... cd cfitsio ./configure make 3) Compile the package: First check that the make you are using is GNU make. You can check by typing: make -v You should see something like: GNU Make version 3.79.1, by Richard Stallman and Roland McGrath. Built for sparc-sun-solaris2.5.1 Copyright (C) 1988, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000 ... Make sure that you have skycat in your PATH environment variable: set path=($path path/to/skycat ) Go in the directory /gmmps-0.304-REL/src and type: ./createplatform this will detect your platforms, create bin. and lib.. (You can see what platform gmmps thinks you are on by running ./discoverOS.sh.) This script then will copy some files to the lib created... e.g. cfitsio's lib, but does not copy the skycat lib. Instead it uses "locate" to try to find the library and print a line you can use to copy the file after making sure libcat is the correct and current version. If this library is not available, there will be a link problem. If using skycat 3.1.1 then the library is in /usr/local/lib and it does not need to be copied. Stay in the directory gmmps/src and type: make clean make all 4.) Create a launching script. You can now create a script to launch GMMPS. To do this simply run: gmmps-0.304-REL/install And an appropriate installation file will be created for your in your /gmmps-0.304-REL/bin directory. 5.) Run GMMPS While /gmmps-0.304-REL/bin/gmmps will start GMMPS, it is better if you add the gmmps-0.304-REL/bin directory to your PATH environment variable, by editing your personal shell configuration file. For the C-Shell it is: setenv PATH ${PATH}:/gmmps-0.304-REL/bin Also need to make sure skycat is in your PATH environment variable: For the C-Shell it is: setenv PATH ${PATH}:/path/to/skycat Start the GMMPS mask making software with the command: gmmps & This will bring up the skycat tool. The users manual is now on the web, see http://www.gemini.edu/sciops/instruments/gmos/gmosMOSobserver.html