CIS LEVEL 3 "cl" SOFTWARE (16 July 2007)

cl v8.2 SOFTWARE INSTALLATION

30 September 2008

Please, if you use CL products in publications/presentations, it would be nice to acknowledge our efforts in a sentence like:
"We thank E. Penou from CESR-Toulouse University/CNRS who developed the cl software for the data display".

This file explains how to install "cl", the LEVEL 3 SOFTWARE for CLUSTER on Solaris, Linux, Mac OS X and Windows.

NEW

- cl now available for Mac Os X (tested on ppc and Intel)

- cl have now the same features on all platforms

- Under Unix, cl can be compiled in both 32 and 64 bits

- No need to have an IDL license (IDL Virtual Machine is sufficient)

- Software compatible with the new (17 Nov 2005 or later) calibration files

For Windows, you must have the following:

- the file cl_v*_YYYYMMDD_Windows_*.zip or file cl_v*_YYYYMMDD_Windows_*.exe

- a PC running Windows 2000 or XP (IDL Virtual Machine cannot run under Windows 98 or ME)

- IDL Virtual Machine v6.3 (or higher) for Windows. Download it from the CIS Web server or from http://www.rsinc.com/download. It's free. Install this software where you want on your PC (ex: C:\Program Files\RSI)

(- gzip.exe v1.2.4. Download it from the CIS Web server or from http://www.gzip.org/#exe. It's free. Copy this file in C:\WINDOWS.) NOT SURE THAT IT’S NECESSARY

For Linux, Mac OS X and Solaris, you must have the following:

- the file cl_v*_YYYYMMDD_Unix*.tar.gz in your home directory

- the file LIB_DOUBLE_STAR.tar.gz in your home directory (for Double-Star only)

(- the utiliy gzip installed) NOT SURE THAT IT’S NECESSARY

- a C compiler: gcc or cc installed

- idl v5.4 or higher installed or IDL Virtual Machine v6.3 or higher installed

- package ncurses-devel installed (yum install ncurses-devl if necessary)

If you have only IDL Virtual Machine, the IDL compilation will fails but you will be able to use clvm

Choose a hard disk to install the data and the software. At CESR, we use /DATA. Under this directory, create the following structure (the directories ACE, ASPERA3, CLUSTER/CDF, CLUSTER/ORBITO, DEMETER, DOUBLE_STAR and MGS are optional):

| |- K0_EPM -|- AC_K0_EPM_yyyymmdd_Vvv.CDF files

| |- K0_SIS -|- AC_K0_SIS_yyyymmdd_Vvv.CDF files

| |- K0_SWE -|- AC_K0_SWE_yyyymmdd_Vvv.CDF files

| |- K1_MFI -|- AC_K1_MFI_yyyymmdd_Vvv.CDF files

|- CLUSTER -|- CALIB -|- CLUSTER1 -|- CIS calibrations files for SC1

| | |- CLUSTER2 -|- CIS calibartions files for SC2

| | |- CLUSTER3 -|- CIS calibrations files for SC3

| | |- CLUSTER4 -|- CIS calibrations files for SC4

| |

| |- CDF -|- CIS -|- CLUSTER1 -|- C1_PP_CIS_yyyymmdd_Vvv.cdf files

| | |

| | |

| | |- CLUSTER2 -|- C2_PP_FGM_yyyymmdd_Vvv.cdf files

| | |- CLUSTER3 -|- C3_PP_FGM_yyyymmdd_Vvv.cdf files

| | |- CLUSTER4 -|- C4_PP_FGM_yyyymmdd_Vvv.cdf files

| |

| | |- CLUSTER2 -|- SC1 L3 data files for day yyyymmdd

| | |- CLUSTER3 -|- SC1 L3 data files for day yyyymmdd

| | |- CLUSTER4 -|- SC1 L3 data files for day yyyymmdd

| |

| |- ORBITO -|- CLUSTER1 -|- C1_L3_CISxxx_yyyymmdd_Vvv_ORBITExxxx.sdd files

| | |- CLUSTER2 -|- C2_L3_CISxxx_yyyymmdd_Vvv_ORBITExxxx.sdd files

| | |- CLUSTER3 -|- C3_L3_CISxxx_yyyymmdd_Vvv_ORBITExxxx.sdd files

| | |- CLUSTER4 -|- C4_L3_CISxxx_yyyymmdd_Vvv_ORBITExxxx.sdd files

| |

|- DOUBLE_STAR -|- CALIB -|- DOUBLE STAR calibration files

| |

| |

| |- CDF -|- FGM - |- T1_PP_FGM_yyyymmdd_Vvv.cdf files

|- THEMIS -|- DATA -|- tha

| |- thb

| |- thc

| |- thd

| |- the

For Cluster:

You must also have the CLUSTER data files:

- L1 files in the directories /DATA/CLUSTER/DATA/L1/YYYYMMDD/CLUSTERi

- L2 files in the directories /DATA/CLUSTER/DATA/L2/YYYYMMDD/CLUSTERi

- L3 files in the directories /DATA/CLUSTER/DATA/L3/YYYYMMDD/CLUSTERi

where:

YYYYMMDD: date

CLUSTERi: spacecraft number i

You can change the directory /DATA/CLUSTER/DATA (it's just the directory we use in CESR). In this case, it's necessary to change this directory in the cl software.

The files in CLUSTER/CDF and CLUSTER/ORBITO are optional.

You must also have the CLUSTER calibration files in the directory /DATA/CLUSTER/CALIB. This directory must contain the 4 directories CLUSTER1, CLUSTER2, CLUSTER3, CLUSTER4. Each directory must contain the calibration files for one spacecraft. These files are available on the CIS Web server (http://cluster.cesr.fr:8000, "software" page). It's necessary to download all these calibration files and to put them in the directories /DATA/CLUSTER/CALIB/CLUSTERi where i is the spacecraft number.

For Double-Star:

You must also have the DOUBLE_STAR data files:

- L1D files in the directory /DATA/DOUBLE_STAR/DATA/L1D/YYYYMMDD

- L2 files in the directory /DATA/DOUBLE_STAR/DATA/L2/YYYYMMDD

where:

YYYYMMDD: date

You must also have the DOUBLE_STAR calibration files in the directory /DATA/DOUBLE_STAR/CALIB. These files are available on the CIS Web server (http://cis.cesr.fr:8002/calibrations). It's necessary to download all these calibration files and to put them in the directory /DATA/DOUBLE_STAR/CALIB.

Installation on Linux, Mac OS X and Solaris

1) Decompress the file cl_v*_YYYYMMDD_Unix*.tar.gz

gzip -d cl_v*_YYYYMMDD_Unix*.tar.gz

For Double-Star, decompress the file LIB_DOUBLE_STAR.tar.gz

gzip -d LIB_DOUBLE_STAR.tar.gz

2) Choose a directory to install: <install_dir1> and untar cl_v*_YYYYMMDD_Unix*.tar

mkdir -p <install_dir1>/CLUSTER/SOFT (recommend <install_dir1> = /DATA)

cd <install_dir1>/CLUSTER/SOFT

tar xvf ~/ cl_v*_YYYYMMDD_Unix*.tar

For Double-Star, choose a directory to install LIB_DOUBLE_STAR:<install_dir2> and untar LIB_DOUBLE_STAR.tar

mkdir -p <install_dir2>/DOUBLE_STAR/SOFT (recommend <install_dir2> = /DATA)

cd <install_dir2>/DOUBLE_STAR/SOFT

tar xvf ~/LIB_DOUBLE_STAR.tar

3) Edit your "~/.cshrc" file

add the following lines (line 2 for Double-Star only):

setenv CIS_ROOT <install_dir1>/CLUSTER

setenv DSP_ROOT <install_dir2>/DOUBLE_STAR

set path = ($path $CIS_ROOT/SOFT/CLL3/bin)

add path for IDL (the script idl must be in <idl_directory>/idl/bin) with these 2 lines:

set path = ($path <idl_directory>/idl/bin)

source <idl_directory>/idl/idl/bin/idl_setup

4) "source ~/.cshrc"

5) Compilation

cd $CIS_ROOT/SOFT/CLL3

genere.sh all

By default, genere.sh:

- uses the cc compiler under Solaris and gcc under Linux and Mac OS X

- under Linux and Mac OS X, compiles in 32 bits mode on 32 bits computer, and 64 bits mode on 64 bits computer

- under SunOs, compiles in 32 bits mode

To force compilation in 32 bits mode: "genere.sh -32 all"

To force compilation in 64 bits mode: "genere.sh -64 all"

Using gcc under Solaris:

- use the command "genere.sh -gcc all"

- install the patch 106950-11 if you OS is Solaris 2.7

IMPORTANT: it's better to use gcc than cc (excutable code is faster on Sun!)

IF YOU HAVE IDL VIRTUAL MACHINE, THE FINAL COMPILATION WILL FAILS but you will be able to use clvm (the IDL pseudo-code is in the distribution).

6) Download the calibration files (see A)

For Cluster: put the calibrations files of spacecraft i in the directory <install_dir1>/CLUSTER/CALIB/CLUSTERi

For Double-Star: put the calibrations files in the directory <install_dir2>/DOUBLE_STAR/CALIB

7) Download some data files (see A)

8) Try the cl software

cl uses IDL

clvm uses IDL Virtual Machine

Installation on Windows

- Download the file cl_v*_Windows_*.zip from the CIS Web server and extract its contains in \DATA\CLUSTER\SOFT. A directory CLL3 must be created. Create the directory \DATA\cl and copy the very small file \DATA\CLUSTER\SOFT\CLL3\bin\clvm.sav in \DATA\cl\clvm.sav

- Download the file cl_v*_Windows_*.exe from the CIS Web server and execute it. It must create files \DATA\CLUSTER\SOFT\CLL3 and \DATA\cl\clvm.sav (if you don’t like the drive where the soft will be installed, choose No to change drive).

- Create a shortcut "cl" on your Windows office pointing to file \DATA\cl\clvm.sav (In Explorer, move right mouse button from \DATA\cl\clvm.sav to Windows office)

- Create a directory \tmp (used to store temporary uncompressed data files)

- Download the calibrations files for Cluster (and Double-Star if necessary) (see A)

- Download some data files (see A)

- Click on the shortcut to try the cl software

For all platforms

Inside the cl software, change the following:

- In Preferences/Cache, put the cache size to maximum 40 % of your computer memory size (for 32 bits operating system, especially for Windows, memory problem appears with cache grater than 1 giga bytes)

- In Preferences/General, check the values of the following variables:

Variable	HTTP server	LOCAL Directory	NFS directory	Use
Value	aspera.cesr.fr	/DATA	/nfs	Local

- Put the variable Use to 'LOCAL' if you want to use local path (files on your hard disk). Put this variable to 'NFS' if you want to use the alternative NFS path (for example data from an Unix server seen on a mounted NFS filesystem or a Samba server seen on mounted drive Z:). Put this variable to ‘LOCAL_AND_HTTP’ if you want to use local path but http server for data missing in local path. Put this variable to ‘LOCAL_AND_NFS’ if you want to use local path but nfs path for data missing in local path.

- To use HTTP server, you need to have a login and password.

Remarks:

- On a standalone computer, to reduce hard disk space, all data files (except CALIB and SOFT) can be compressed with gzip.

- Don't remove the directory \tmp because it is used by cl to store uncompressed files (these files are automatically removed at the end of cl session)

- Don't remove the file \DATA\cl\cl.cfg ($HOME/cl.cfg under Unix) which contains parameters for cl. Remove this file if it is corrupted and cl cannot run (it will be re-created at the end of the next cl session).

- The hard disk \tmp must contain enough space to store uncompressed files.

- Under Windows, \DATA\cl is the directory used by default by cl.

- See Help/Documentation for more information.

- If you have any problems when reading or writing CDF files with IDL 6.x, patch IDL (see http://cdf.gsfc.nasa.gov/html/cdf_patch_for_idl6x.html or http://cdf.gsfc.nasa.gov/html/cdf_patch_for_idl6x_new.html)

(A) To use HTTP server, you need to have a login and password. If you have such access, you can download Data and Calibration files by HTTP (Help/Check for calibration update, Help/Check for data update). Cl will create necessary directories. Only new or modified files will be updated

In any case, you can send me an e-mail at emmanuel.penou@cesr.fr