ADMIT Installation Notes

From CARMA
(Difference between revisions)
Jump to: navigation, search
(Running an NGC 253 test dataset)
(ADMIT for developers:)
Line 9: Line 9:
 
   source admit_start.csh
 
   source admit_start.csh
  
This will define the $ADMIT environment variable.  There is also a top level INSTALL file, which contains more hints to install ADMIT with advanced options, most of which you will not need to get started.  
+
This will define the $ADMIT environment variable.  There is also a top level INSTALL file, which contains more hints to install ADMIT with advanced options, most of which you will not need to get started. If you do not have '''autoconf''' installed, you can try and download the (possibly outdated) [[http://www.astro.umd.edu/~teuben/admit/dist/admit-cvs.tar.gz]] file instead.
  
 
The command
 
The command

Revision as of 22:26, 15 June 2015

Contents

ADMIT for developers:

You will need to know where CASA is installed on your machine (see our CASA support page). The following (csh) commands get your started on installing ADMIT (use USER = anonymous to get a read-only version, developers should know their USER name). bash users use the .sh variant.

  cvs -d :pserver:anonymous@cvs.astro.umd.edu:/home/cvsroot checkout admit
  cd admit
  autoconf
  ./configure --with-casa-root=/astromake/opt/casa/stable
  source admit_start.csh

This will define the $ADMIT environment variable. There is also a top level INSTALL file, which contains more hints to install ADMIT with advanced options, most of which you will not need to get started. If you do not have autoconf installed, you can try and download the (possibly outdated) [[1]] file instead.

The command

  admit

will remind you that ADMIT has been installed, it doesn't do anything other than that right now. The top level Makefile also has some useful reminders what can do now and to do some very basic testing of ADMIT in a CASA environment. For example

  make python0
  make python1
  make pdf
  make html
  make doc

and to simulate the buildbot

  make buildbot

For beginning developers this may not work if you don't have sphinx added to your CASA, in that case use

  make unit

although that currently does very little testing.

We do have some **rogue testing** installed, these are basically python (pure python as well as casarun-python) scripts that run through some Flow*_AT's. You can run them via

  make unit0_clean
  make unit0
  make unit0


and they should not fail. The 2nd run will re-run an existing test and should also not fail. Those test_Flow* scripts are instructive to see how basic Flow's can be created using ADMIT.

Running an NGC 253 test dataset

This example

  cd $ADMIT
  make data n253
  cd data
  $ADMIT/admit/test/admit1.py ngc253_fullcube_compact_spw3_clean.ce.fits  x >&  x.log
  

should give lots of interesting things to look at in a directory called ngc253_fullcube_compact_spw3_clean.ce.admit. The x.log file might be useful for developers to look at in the casa where things don't look so interesting. This example should take about 2 minutes.

Enhancing your CASA with extra tools

For reasons beyond our control, CASA comes with its own python, which in a default installation isn't even accessible to mortal users. You will need to enhance your shell to see and work with that python. Installing ADMIT will take care of this last part, but if you don't have write permission into your version of CASA, there is only a limited number of things you can do as a developer. You would not be able to build the documentation, as this requires sphinx to be installed within CASA's python. See also casa-python and drive-casa for ways to interact with CASA and its python.

Here's a recipe for installing sphinx: (you don't need an active $ADMIT, just the get-pip.py)

   % cd $ADMIT/integration-test
   % casapy --nologger --nogui
   : !python get-pip.py
   : quit
   % rehash
   % which pip
   # confirm that this is now in casa's path
   % pip install sphinx
   % pip install numpydoc


There are a number of interesting modules you can install within your CASA python, if you want direct access to them.

   % make all

will check them for you, and report the version of the ones you have in your python environment.

ADMIT for users:

A user installation is expected to be using conda or egg based. We have experimented some with this, but nothing stable is available at the time.

Personal tools