Skip to content

Commit

Permalink
Merge pull request #124 from Keck-DataReductionPipelines/develop
Browse files Browse the repository at this point in the history
Merging minor update v6.0.2
  • Loading branch information
followthesheep authored Jul 22, 2023
2 parents de57c46 + df6bf6e commit 0601063
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 16 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@
* [Testing the Pipeline](#testing-the-pipeline)
* [Citing the Pipeline](#citing-the-pipeline)


## Release Notes for v6.0.2
**2023-07-21**
- Modified QLook2 so that it can load FITS files without correct image headers without launching a dialog box that must be closed to continue. This helps to support saving all reads in up the ramp mode and visualizing it.

## Release Notes for v6.0.1
**2023-05-02**
- Small changes to the ``run_odrp`` and ``osirisDropDRF`` scripts to run better on more modern Linux environments.
- Added more instructions on how to install on Linux
- Added instructions on downloading test data for testing the pipeline



## Release Notes for v6.0
**2022-04-12**
- Update to the manual including: discussion of new imager, new tables of sensitivities for imager and spectrograph, updates on how to observe with the TRICK NIR TT sensor, discussion of the new exposure time calculator, new discussion of the OSIRIS imager reduction pipeline KAI.
Expand Down Expand Up @@ -67,13 +80,14 @@ Please cite [Lyke et al. (2017)](https://ui.adsabs.harvard.edu/abs/2017ascl.soft
To install and run the OSIRIS DRP, you will need the following:

- A working C compiler (e.g. ``gcc``)
- A copy of the compiled library cfitsio
- A copy of the compiled library cfitsio (for Linux, it's best to use the version that can be insalled with your package manager like ``apt``)
- For Linux users: note that while you can use the bash shell and bash environment, some of the scripts require cshell to launch so you will need to install it. Newer versions of linux often lack cshell. To install on Ubuntu use ``sudo apt get csh``.
- A working installation of IDL 7 or IDL 8 (the IDL binary directory should be in your ``PATH`` environment variable)
- Python dependencies (optional, for testing): pytest, astropy
- If using a computer with Apple M1 ARM chips, see [INSTALLPROBLEMS.md](https://github.com/Keck-DataReductionPipelines/OsirisDRP/blob/master/INSTALLPROBLEMS.md) for a workaround.
- ODRFGUI: Java version 17 (newer versions of Java are likely to run into issues when running the GUI)



### Installing from source

Either clone or download the source from github, choose either the master branch or the develop branch.
Expand All @@ -82,16 +96,16 @@ Either clone or download the source from github, choose either the master branch

Set up the following environment variables to compile the code (you can remove these variables after compiling). The defaults should work for installations of IDL on Mac OS X and CFITSIO installed using [MacPorts][]:

- ``IDL_INCLUDE``: The IDL include directory. If you don't set ``IDL_INCLUDE``, it defaults to ``IDL_INCLUDE=/Applications/exelis/idl/external/include``
- ``CFITSIOLIBDIR``: The directory containing your installation of CFITSIO. If you don't set ``CFITSIOLIBDIR``, it will default to ``CFITSIOLIBDIR=/opt/local/lib``, which is correct for [MacPorts][].
- ``IDL_INCLUDE``: The IDL include directory. If you don't set ``IDL_INCLUDE``, it defaults to ``IDL_INCLUDE=/Applications/exelis/idl/external/include``. On linux, this might be ``IDL_INCLUDE=/usr/local/harris/idl/external/include``
- ``CFITSIOLIBDIR``: The directory containing your installation of CFITSIO. If you don't set ``CFITSIOLIBDIR``, it will default to ``CFITSIOLIBDIR=/opt/local/lib``, which is correct for [MacPorts][]. On Ubuntu Linux, you can install ``libcfitsio-dev`` from ``apt``. The library is then located at ``CFITSIOLIBDR=/usr/lib/x86_64-linux-gnu``

Run the makefile from the top level of the OSIRIS DRP source code:

```
make all
```

You should see that the pipeline has been built correctly. Be sure you are using ``gmake`` (which on OS X is the only ``make``, so using ``make`` works.)
You should see that the pipeline has been built correctly by seeing that the file ``modules/source/libosiris_drp_ext_null.so.0.0`` exists.

[MacPorts]: https://www.macports.org

Expand Down Expand Up @@ -147,6 +161,13 @@ to open a new xterm window, call ``run_odrp -n``.
Please check out the OSIRIS pipeline manual: OSIRIS_Manual_v5.pdf in this directory.


### Testing the Pipeline

You can run the xml file in ``tests/test_emission_line/emission_obj.xml`` by downloading the following files:
- [s150531_a025001.fits](https://drive.google.com/file/d/0B_YkzZoUSrX-bUtKOXFmalNxQ3M/view?usp=share_link&resourcekey=0-NSjQcVOu5To5S0Jx5QlXHA) - place in ``tests/test_emission_line/``
- [s150531_a025002.fits](https://drive.google.com/file/d/0B_YkzZoUSrX-bkJGbnc3Zzh3amM/view?usp=share_link&resourcekey=0-6j9yF66ERZxd2xj7LkRQRA) - place in ``tests/test_emission_line/``
- [s150901_c008___infl_Kn5_035.fits](https://drive.google.com/file/d/0B_YkzZoUSrX-azZsWEV0clVUbnM/view?usp=share_link&resourcekey=0-rcn-lVT8bc4LhUCmYmJWvQ) - rectification matrix to be placed in ``tests/calib/``

### OOPGUI & ODRFGUI settings

To set the default directories for the guis, you can edit the following two files:
Expand Down
2 changes: 1 addition & 1 deletion backbone/version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.0
6.0.2
25 changes: 17 additions & 8 deletions ql2/cimwin__define.pro
Original file line number Diff line number Diff line change
Expand Up @@ -1723,11 +1723,11 @@ if (itime ne 0) then begin


endif else begin
print, ['Could not find the coadds keyword.', $
print, ['ERROR: Could not find the coadds keyword.', $
'No manipulation of the data']
endelse
endif else begin
print, ['Could not find the integration time keyword.', $
print, ['ERROR: Could not find the integration time keyword.', $
'No manipulation of the data']
endelse

Expand Down Expand Up @@ -2918,14 +2918,23 @@ pro CImWin::DisplayAsDN, no_rescale=no_rescale
itime=sxpar(hd, itime_kw, count=itime_count)
coadds=sxpar(hd, coadds_kw, count=coadd_count)
if itime_count eq 0 then begin
message=['Could not find the coadds keyword.', $
'No manipulation of the data']
answer=dialog_message(message, dialog_parent=self.BaseId, /error)
message=['ERROR: Could not find the coadds keyword.', $
'No manipulation of the data']
;; commented this out so that it can display images of
;; individual reads which do not have headers.
;;answer=dialog_message(message, dialog_parent=self.BaseId, /error)

;; instead, print out to the terminal
print, message
endif
if coadd_count eq 0 then begin
message=['Could not find the integration time keyword.', $
'No manipulation of the data']
answer=dialog_message(message, dialog_parent=self.BaseId, /error)
message=['ERROR Could not find the integration time keyword.', $
'No manipulation of the data']
;; commented this out so that it can display images of
;; individual reads which do not have headers.

;; answer = dialog_message(message, dialog_parent = self.BaseId, /error)
print, message
endif

print, "Integration time was ", itime
Expand Down
18 changes: 17 additions & 1 deletion scripts/osirisDropDRF
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
#!/bin/csh -f

cp $1 $DRF_QUEUE_DIR/$2.$1:r.waiting
if ( ! -d "$DRF_QUEUE_DIR" ) then
echo "Error: $DRF_QUEUE_DIR does not exist or is not a directory"
exit 1
endif

if ( ! -e "$1" ) then
echo "Error: $1 does not exist or is not a file"
exit 1
endif

if ( ! -w "$DRF_QUEUE_DIR" ) then
echo "Error: insufficient permissions to write to $DRF_QUEUE_DIR"
exit 1
endif

cp "$1" "$DRF_QUEUE_DIR/$2.$1:r.waiting"

2 changes: 1 addition & 1 deletion scripts/run_odrp
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

#setenv OSIRIS_BACKBONE_DIR $KROOT/rel/default/idl/odrs/backbone

if ( $?1 & $1 == "-n" ) then
if ( $1 == "-n" ) then

onintr -
idl -IDL_STARTUP ${OSIRIS_BACKBONE_DIR}/drpStartup.pro ${OSIRIS_BACKBONE_DIR}/osiris_drp_backbone_startup.pro
Expand Down

0 comments on commit 0601063

Please sign in to comment.