1. NHSC PACS How to Use getObservation And saveObservation To Access and Save Herschel Data in HIPE Yi Mei (NHSC/Caltech) Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data 1

2. Introduction In HIPE (Herschel Interactive Processing Environment), one needs to access and save Herschel data. There are multiple different methods, mainly in GUI or command-line. E.g., the Herschel Science Archive User Interface (HUI) or Product Brower are GUIs. One can also run commands either in the Console or in scripts. Herschel develops those methods to benefit people with different preferences. The advantages of the command-line/script method: Straight forward input parameter control Can be saved and reused in the scripts Scripts can have features GUI don’t, like loop, batch jobs, and so on Two basic commands for Herschel data accessing and saving: The command getObservation to load data into HIPE. The command saveObservation to save data from HIPE to disk. Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data 2

3. How: After untar the HSA tar ball and extract the content into any directory, type the command in the Console: to load the observation into HIPE. E.g., obs = getObservation(path="/Users/ymei/data/pacs_hsa/PacsPhotometer/ymei176213272”) If the directory contains multiple observations, you must specify the obsid: Use Case: You have searched the Herschel Archive (HSA), and downloaded an observation tar ball to your computer. You would like to load the observation into HIPE via the command line. How to load the HSA tar ball into HIPE Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data obs=getObservation(path=“/path/to/the untarred directory”) obs=getObservation(path=“/path/to/the untarred directory”, obsid= ”) What just happened? The observation variable, obs, appears in the Variables view. Your data are still in the directory from the uncompressing the tar file. The observation has been indexed in the MyHSA repository but not copied to elsewhere. Please do not modify, move or delete the data directory! 3

4. How: 1) Login to HSA. 2) Type the command in the Console: E.g., obs = getObservation(1342186235, useHsa=True) 3) For SPIRE PACS Parallel mode, you need to specify the instrument: Use Case: You have searched the Herschel Archive (HSA), and collected the obsids (observation identifiers) you are interested. You would like to glance the data in HIPE before downloading them to your computer. How to retrieve observations directly from HSA into HIPE Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data What just happened? The observation context variable, obs, is created to reference the data. Your data have been indexed in the MyHSA repository but not downloaded. You can retrieve the observation any time afterwards from MyHSA to HIPE by obs=getObservation( ) (see more about this later) obs = getObservation(, useHsa=True) obs = getObservation(, instrument = ‘ ’, useHsa=True, ) 4

5. How: 1) Login to HSA. 2) Type the command in the Console: E.g., obs = getObservation(1342191353, useHsa=True, save=True) Use Case: You have searched the Herschel Archive (HSA), and collected the obsids (observation identifiers) you are interested. You would like to download the data to your computer. How to retrieve observations directly from HSA into HIPE and save to your computer Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data What just happened? Your observation is referenced by the variable obs. Your data have been downloaded to the MyHSA repository. You can retrieve the observation any time afterwards from MyHSA to HIPE by obs=getObservation( ) (see more about this later) obs = getObservation(, useHsa=True, save=True) Warning: Saving will take a while! 5

6. Use Case: You would like to save the observations, either just glanced or reprocessed, into a local pool on your computer. (MyHSA can only store the data directly from HSA.) How to save observations into the local pools Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data How: E.g., the command saveObservation(obs, poolName=“PACSPhoto_1342191353”, poolLocation=“/Users/ymei/newPoolLocation”) saves the observation obs into the pool /Users/ymei/newPoolLocation/PACSPhoto_1342191353. The default poolLocation is /$HOME/.hcss/lstore and the default poolName is the obsid. So saveObservation(obs) will save the above observation into the pool /Users/ymei/.hcss/lstore/1342191353. saveObservation(, poolName=“ ”, poolLocation=“ ”) Warning: Saving will take a while! 6

7. Use Case: You have saved some observations in your computer, either into MyHSA repository or some local pools. You would like to load them back to your HIPE. How to load observations from your computer into HIPE Y. Mei NHSC Data Workshop – August 26 th – 30 th 2013 Access PACS data Note. How: The command searches for the observation with the obsid in the pool at the pool location. E.g., obs = getObservation(1342191353, poolName=“PACSPhoto_1342191353”, poolLocation=“/Users/ymei/newPoolLocation”) The command searches the following locations: (1)The pool with poolName= (2)Any other pools in the default pool location: $HOME/.hcss/lstore (3)MyHSA The Console will show where the data is retrieved from. obs = getObservation(, poolName=“ ”, poolLocation=“ ”) Obs = getObservation( ) 7

8. Document getObservation: Data Analysis Guide (howtos): 1.2, 1.4, 1.5 and 1.7 saveObservation: Data Analysis Guide (howtos): 1.9 8