Download and Installation Guide for GIPSY64

This is the installation manual for GIPSY64. That is a new distribution (July 2019) which supports 64 bits coordinate words to handle large data sets, Qt5, the latest compilers and which is compatible with recent Anaconda distributions. We plan Python 3 support in a couple of months.

Contents:

Requirements

This document describes how to install GIPSY64. We assume you have an existing Python installation with packages like NumPy, SciPy, Astropy, Matplotlib and some others. Preferably installed with an Anaconda distribution for Python 2.

Below is a list of requirements to install and run GIPSY on one of the above systems. Please note that depending on the operating system distribution, some software may already be provided and other software can be installed from repositories belonging to that distribution. In those cases there is no need to download and install it manually. Separate pages with preparation instructions are available for

We did not manage to get VTK based tasks to run in recent environments and therefore will not set its libraries as an requirement.
We completely abandoned support for 8 bit pseudocolor and 16 bits directcolor. The old display task GIDS cannot be used anymore. Its alternative is called VISIONS. You can write your own tasks in C, Fortran, Sheltran and Python. We still require Python 2 but are in the process of migrating to Python 3. Below a description of common requirements.

Step 0: Download the source

First create a directory gipsy in the tree where you want to keep the GIPSY source files. It is advisable to create a user gipsy, but this is not really necessary. When you have a user gipsy on your system, the GIPSY root directory should be the HOME directory. Do not install GIPSY as root to avoid problems with ownership of downloaded files.

You will end up with a GIPSY directory tree with the following subdirectories:

Installation step 1: Clients file

Go to the GIPSY system directory with:
        cd $gip_root/sys
You are now in the directory which contains all the GIPSY system files. Make the current host a GIPSY client with:
        ./mkclient.csh  <number>
<number> denotes the GIPSY client mode and should be one of the following:
<number>            What GIPSY client may/can do
              RUN COMPILE INSTALL SUID GLOCK NOOLD REMOTE GFTP LINK
    65         +1                                     +64           =  65
    71         +1     +2      +4                      +64           =  71
   103         +1     +2      +4               +32    +64           = 103
   199         +1     +2      +4                      +64 +128      = 199
   231         +1     +2      +4               +32    +64 +128      = 231
   487         +1     +2      +4               +32    +64 +128 +256 = 487
It should be 71 or 103 If your machine does not allow set owner and set group ID on the disk where the GIPSY sources are stored, you may have to add 8 to the GIPSY client code.

The mkclient.csh script creates an entry in the clients file, which resides in $gip_root/loc. The modified file is in the current directory and is called clients.new. You should check this file and if necessary, modify it. Usually the fields which are modified are the paths to the GIPSY exe, lib and tmp directories.

A description of the clients file and the mkclient.csh script can be found in $gip_root/doc/clients.doc and $gip_root/doc/mkclient.doc resp. After inspecting and/or modifying the file client.new type:

        mv clients.new $gip_root/loc/clients
Next type:
        source cshrc.csh

This should define the necessary environment variables. A description can be found in $gip_root/doc/cshrc.doc.

Installation step 2: Compiler setup

The next step is to create the setup file for the compilers in the $gip_loc directory ($gip_loc is defined as $gip_root/loc by the gipenv.csh script). You can check the $gip_sys/setup.mgr file for entries which match your local situation. Now copy the file with:
        cd $gip_loc
        cp $gip_sys/setup.mgr setup 
For standard installations, usually no editing is necessary. Otherwise, delete all the lines that are not relevant and do NOT delete the last (comment) line! (see also $gip_doc/setup.doc).

Next we have to compile the compile program, the file extractor, the Fortran to C interface program, the GIPSY lock server, the Sheltran compiler, the GIPSY file transporter and install the fonts for PGPLOT. This can be done with the install script. This script will check whether the necessary directories are present and create them if possible and necessary. In principle only the system dependent directories will be created. In order to run install type

        cd $gip_sys
        ./install.csh
If it complains, then probably some variables are not yet set, and running install again might provide the solution. See $gip_doc/install.doc for a description. Note that the install script tries to send a mail with registration information to the GIPSY server. If you don't want that, then comment out the calls to 'register.sh' in the scripts 'install.csh' and 'gipsy.csh' (both in $gip_sys).

Installation step 3: Building the sources

Now you have to build the GIPSY library and the GIPSY applications. Type:
        cd $gip_sys
        ./mkbookkeeper.csh
        mv bookkeeper.new bookkeeper
If you have the ftp bit on in $gip_loc/clients (bit 8), turn it off by subtracting 128 from field 3 in $gip_loc/clients. Next type:
        p -update > & p.log & 

This will generate the GIPSY library and the GIPSY applications. It is the most time consuming part of the installation. Use command: tail -f p.log   in a separate terminal to check the compilation.

Note that when you kill 'p' there might be some lock files which will not allow 'p' to be restarted. You will have to remove the lock files by typing:

        rm -f $gip_sys/.*lock $gip_sys/*.lock $gip_tmp/update.lock
You should inspect the log file p.log for any errors. If there are any, try to find out what caused them. If you can't solve the problem by adjusting setup parameters or installing missing software components, such as libraries or header files, you can contact the GIPSY manager at Groningen (gipsy@astro.rug.nl).

Installation step 4: Local system setup

You can skip this section if you don't have legacy hardware like text printers and magnetic tape readers.

In order to get the system running properly, you may have to edit the following setup files in the $gip_loc directory:

        File                Purpose                              Documentation

        grdevices           Contains info about graphics devices $gip_doc/grdevices.doc
        lpdevices           Contains info about text printers    $gip_doc/lpdevices.doc
        mtdevices           Contains info about tape units       $gip_doc/mtdevices.doc
        tvdevices           Contains info about X11 servers      $gip_doc/tvdevices.doc

Installation step 5: Set the environment

Each user who wants to use gipsy has to put the following lines into his or her .cshrc file:
        setenv gip_root <PATH_TO_GIPSY_ROOT_DIRECTORY>
        source $gip_root/sys/gipenv.csh
Also inspect cshrc.csh to find out whether your system needs some special setings. If so, incorporate them into your .cshrc.

Post installation: Regular updates

Updates for this distribution cannot yet be done in the way it could with the original version of GIPSY. The architecure of the GIPSY distribution was not meant to support multiple versions. The plan is to create two separate systems that cannot interfere with each other.

Post Installation: Troubleshooting

You may run into problems installing, running or compiling GIPSY. Here are some things to check first before contacting the GIPSY group in Groningen.
  1. Check whether you have the correct version of the operating system and the compilers mentioned above. You may have to make small modifications to $gip_loc/setup to enable correct compiling.
  2. Check whether you have initialized the gipsy environment in your .cshrc file. Each user must have the following statement in his/her .cshrc file:
          setenv gip_root 
          source $gip_root/sys/gipenv.csh
    
    Also inspect $gip_sys/cshrc.csh for any other system specific settings.
  3. Then check whether you have made the necessary modifications to the setup files.
  4. NumPy generate warnings when np.asscalar() is used. With the installation of Anaconda2 version 2019.03 one gets a Matplotlib which has still some np.asscalar() functions. In some applications, this generates many warnings. You can repair this by changing Matplotlib's code according to: https://github.com/matplotlib/matplotlib/commit/62297d167c2b7ac8305ba6a60ec0191c6e7a09af
    These warnings cannot be suppressed in the GIPSY code. Newer releases should include a Matplotlib version where the np.asscalar() functions are replaced by np.item(). Until then, you could consider to alter a couple of lines in the Matplotlib code.

Post Installation: Creating a dummy set

Test to create a dummy set with task CREATE
Start GIPSY64
Type !create and press <esc> e

A command line editor will be started (see remark about this editor below if you want to change the default). Paste the list with keywords below. Save the file and exit. Task CREATE will start with these keywords and a dummy set 'test' will be created which can be viewed with task VISIONS.

BUNIT=
CDELT1= -0.01
CDELT2= 0.01
CDELT3= 1000000
CROTA2=
CRPIX1= 150
CRPIX2= 100
CRPIX3= 1
CRVAL1= 45
CRVAL2= 30
CRVAL3= 1401000000
CTYPE1= RA---NCP
CTYPE2= DEC--NCP
CTYPE3= FREQ-OHEL
CTYPE4=
CUNIT1=
CUNIT2=
CUNIT3=
DRVAL3= 400
DUNIT3=
FREQ0= 1400000000
FUNCTION= RA*DEC*FREQ
INSTRUME= WSRT
NAXIS1= 300
NAXIS2= 200
NAXIS3= 60
OUTSET= test

Post Installation: A template .cshrc file

To run GIPSY you need TCSH. A template contents of its resource file .cshrc is given below.
#============== TCSH template .cshrc ===============
set filec                                       # enable file completion
#
# History
#
set history = 2000                              # length of history
set histfile=$HOME/.tcshHistory/history.$HOST
set savehist=(2000 merge)
history -L

if ($shell:t == tcsh) then                      # we are running tcsh
         bindkey -k up history-search-backward
         bindkey -k down history-search-forward
endif

if ($?autologout) then                          # if autologout is enable
        unset autologout                        # do not logout automatically
endif                                           # done
#set prompt = "$HOST>"                          # prompt is machine name
set prompt="%U$HOST%u\:%/ >"

setenv gip_root /home/kapteyn/gipsy64   # !! Replace this with your GIPSY home !!
source $gip_root/sys/gipenv.csh

# This  can be useful if you want to override the default editor 'vi'
set     EDITOR = nano
setenv  EDITOR   nano
#===================================================

GIPSY documentation (.doc) files

Additional documentation is stored in the GIPSY documents (doc) directory.

GIPSY references


COPYRIGHT © 1999-2019
Kapteyn Institute, University of Groningen, The Netherlands
All Rights Reserved.


GIPSY