Tree [521001] master /
History



File Date Author Commit
papco 2012-10-01 rfriedel rfriedel [ac9589] updates from rbsp-ect processing
papco_lib 2012-10-01 rfriedel rfriedel [ac9589] updates from rbsp-ect processing
papco_modules 2012-10-01 rfriedel rfriedel [521001] added rbsp-ect processing codes modlue
papco_scripts 2012-02-09 jbfaden jbfaden [093ada] use bash, allow IDL to move, use todos instead ...
tests 2010-05-25 jbfaden jbfaden [8c8ca5] test rank 4.
.cvsignore 2011-07-14 rfriedel rfriedel [5794b3] Json parsers added
readme.txt 2006-10-17 jbfaden jbfaden [4a3a6c] misc corrections and clarifications

Read Me

Install notes for PAPCO package version 12 Beta
==================================================

Sept 22, 2006


A. Before you start
-------------------

1. Requirements.  IDL version 6.1 or above is recommended, but we are trying to
support version 5.6 and up.  Note we observed all sorts of problems with
IDL 6.0.  IDL Runtime support is only provided for IDL versions 6.1 and up.  Testing
is done regularly with IDL 6.1, 6.2, and 6.3 on Windows and Linux platforms.  We
officially support Darwin and Solaris as well, but testing is less frequent.

2. Make sure any old papco_user directories you may have are
removed. There is no guarantee that old papco product files will work with this
version. 

3. There is no documentation yet for the new version - this is a beta
version not yet released.  However, we have made efforts to make things 
intuitive, and you should look for help buttons throughout the widget.

4. You'll need to identify some data space for data files PAPCO will download
(env variable $PAPCO_DLNK). You should only need to create the top level
directory pointed at by $PAPCO_DLNK. This should be an area read/writable by
you. 

5. PAPCO comes packaged with some version of external binaries it needs -
chiefly wget for the remote data capability. 

These are under $PAPCO_BASE/papco_lib/binaries/OS where OS can be linux,
darwin (Mac Os10) or win32 (Windows XP). 

If you have another operating system then you'll need to create a subdirectory
for it under $PAPCO_BASE/papco_lib/binaries/ and put a wget binary into it.

NB: Other flavors of unix are expected to work fine (SUNos, HPUnix, other
linuxes...)  Let us know how things work for you!
NB: VMS is no longer supported
NB: subdir name under $PAPCO_BASE/papco_lib/binaries/ must be same as
!VERSION.OS in IDL. 
NB: You MUST use wget version 1.8.2.

B: Installation of PAPCO
------------------------

1. Goto the following directory: $PAPCO_BASE/papco_scripts

   UNIX (darwin,linux, etc): execute idl papco_install.pro
   WIN32: double click on  papco_install.cmd

   IDL will start up and run a simple install widget asking you to specify
   three environmental variables -

      $PAPCO_USER - your location of your papco user directory for your own
                    defaults, batch files, product files, etc

      $PAPCO_BASE - location of your papco distribution (the directory
                    containing papco, papco_lib, papco_modules and 
                    papco_scripts and this readme file).  Unfortunately there
                    has been a bug observed where spaces will cause problems.

      $PAPCO_DLNK - top level dir of your data space. PAPCO will create all
                    needed data directory hierarchies under this directory.
                    You may later replace some of these directories by links 
                    pointing to other data areas, as long as you keep the link
                    name the same as the original directory name PAPCO
                    created.

    NB: Don't terminate your directory strings with a      
                                     "/" (linux) or "\" (windows).

    Hit "Done" on the install widget to continue. The install will create your
    papco_user directory with all files and directory structure needed.

2. You may need to customize one file for printing in Unix: 
      $PAPCO_USER/papco_printer_config.dat
   Initially, the system default printer is used, and if it's a postscript printer, it should work
   fine.  You may specify the printer queues to use in that file (there will be a widget for
   this soon)...

C: Running papco

Go to to your new papco_user directory. There are three ways to start papco (run
script under UNIX, double click on .cmd file under Windows):

   papco_start_modules - run this first - calls configuration widget for
                         selection of modules to use. Compiles papco and 
                         modules. To start papco widget: IDL> papco
   papco_start         - compiles exisiting configuration.
                         To start papco widget: IDL> papco
   papco_start_papco   - compiles exisiting configuration and then
                         automatically starts the papco main widget.

   papco_runtime - start the runtime version of papco.  This allows use 
           on unlicensed IDL installations or when your license server is not
           available.  You'll get the configuration widget each time, just click
           through to use the last configuration.  Note runtime support is all pretty
           new, and if there is a failure, IDL aborts.  I hope this doesn't happen
           to you, and let us know if it does so we can correct the problem.   Also,
           only the core modules are supported in this mode.  

    papco_runtime_test - start in runtime mode, but on a licensed IDL session
          so that crashes don't abort.  This is also useful for debugging when 
          you are trying to supply a runtime-enabled module.

See the readme.txt file in papco_user for more information.

D: Getting Data
---------------

Most modules now automatically download data not available locally. This
functionality will eventually be in all modules. 
You can also use the "File Cache" button in the module's panel editor to get a
lisiting of the local and remote data available. You can use this tool to
download data too...

Location for most of the data (apart from CDF module)
is a server here at LANL.

If you're at LANL, use the following as the base address for ftp access:
ftp://user:password@nis-ftp.lanl.gov/

As long as there is "user:password" in those URL's PAPCO will prompt you for
them the first time it accesses a new site. 

For the PAPCO data at LANL the user is "papco", call for the password.
For cdf file access from the ISTP archive, access is by anonymous ftp, no
password needed.

R. Friedel
1 505 665 1936
friedel@lanl.gov

Comments on how to improve this documentation are welcome!