Welcome to KCWIKit
!
KCWIKit
is a community developed package to extend the official KCWI DRP with a variety of stacking tools and DRP improvements. The software offers masking and median filtering scripts to be used while running the KCWI DRP, and a step-by-step KCWI_DRP implementation for finer control over the reduction process. Once the DRP has finished, KCWIKit
can be used to stack the output cubes via the Montage
package. Various functions cross-correlate and mosaic the constituent cubes and the final stacked cubes are WCS corrected. Helper functions can then be used to deproject the stacked cube into lower-dimensional representations should the user desire.
This repo is organized as follows:
- docs/ Documentation and Instructions
- kcwi/ Post-DRP stacking.
- scripts/ Covenient command line tools to conduct quick operations for the KCWI data.
- DRP/ Improving the Python pipeline.
- archs/ archival programs for the IDL pipeline.(No longer supported.)
We maintain a separate tool KCWI Sky Wizard
for the telluric correction and sky subtraction.
KCWIKit is recommended to be installed with python <= 3.9
.
-
Activate the KCWI DRP environment.
Or create a new Python environment.
conda create -n kskywizard python=3.8
-
Install
MontagePy
or theMontage
command line tools. The two forms of theMontage
package performs the same functions. You can choose either to install.MontagePy
is generally easier to install if you have the correctPython
environment:pip install MontagePy
Alternative: Install the command line version
If the above installation fails, alternatively, you can choose to install the command line tools by compiling from the source code.
-
Git clone this repository and run the setup tools.
git clone https://github.com/yuguangchen1/KcwiKit.git cd KCWIKit pip install .
-
(optional) Install KCWI Sky Wizard.
KSkyWizard
is a standalone tool to perform telluric correction and advanced sky subtraction based on PCA models for the red channel (KCRM). It is recommended to be run onPython >= 3.11
environments. We refer to the KSkyWizard documentation for the installation and instruction.
-
Installing and running the improved DRP.
1.1. Installing the modified DRP
Here are some examples for the stacking code which are referenced in the instructions.
Some KCWI-red commissioning data are shared here if you would like to try running the code.
KCWIKit is hosting a breakout session at the 2024 Keck Science Meeting!
If you use KCWIKit
, please cite the ASCL entry (BibTeX format on ADS) and Chen et al. 2021 where the code is implemented.
Developed and maintained by Nikolaus Prusinski, Yuguang Chen and Zhuyun Zhuang. If you encounter bugs, have questions on how to run the code, or have feature requests, drop us a line!