kcwikit

Improving KCWI/KDERP pipeline.

https://github.com/yuguangchen1/kcwikit

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

astronomy astrophysics data-reduction
Last synced: 6 months ago · JSON representation ·

Repository

Improving KCWI/KDERP pipeline.

Basic Info
  • Host: GitHub
  • Owner: yuguangchen1
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 7.64 MB
Statistics
  • Stars: 8
  • Watchers: 2
  • Forks: 6
  • Open Issues: 4
  • Releases: 1
Topics
astronomy astrophysics data-reduction
Created almost 8 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

Keck Cosmic Web Imager: Post-Processing and Improvements

ascl:2404.003

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.

Installation

KCWIKit is recommended to be installed with python=~3.12.

  1. Activate the KCWI DRP environment. bash conda activate kcwidrp

    Or create a new Python environment.

    bash conda create -n kcwikit python=3.12

  2. Install MontagePy or the Montage command line tools. The two forms of the Montage package performs the same functions. You can choose either to install.

    MontagePy is generally easier to install if you have the correct Python environment: bash 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](http://montage.ipac.caltech.edu/docs/download2.html).
  3. Git clone this repository and run the setup tools.

    bash git clone https://github.com/yuguangchen1/KcwiKit.git cd KCWIKit pip install .

  4. (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 on `Python >= 3.11` environments. We refer to the [KSkyWizard documentation](https://github.com/zhuyunz/KSkyWizard) for the installation and instruction.

Instuctions

  1. Installing and running the improved DRP.

    1.1. Installing the modified DRP

    1.2. Running the DRP for the blue channel

    1.3. Running the DRP for the red channel

  2. Running the post-DRP stacking code.

  3. Command Line Tools.

Examples

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 at KSM24

KCWIKit is hosting a breakout session at the 2024 Keck Science Meeting!

Citing KCWIKit

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!

Owner

  • Name: Yuguang Chen
  • Login: yuguangchen1
  • Kind: user
  • Company: University of California, Davis

(he/him/his) Postdoc researcher @ UCDavis. Specialized in observational astronomy, and large volume IFU data.

Citation (CITATION.cff)

cff-version: 1.1.0
message: "Please cite the following works when using this software: https://ui.adsabs.harvard.edu/abs/2021MNRAS.508...19C"
authors:
- family-names: Prusinski
  given-names: Nikolaus Z.
- family-names: Chen
  given-names: Yuguang
title: "KCWIKit: KCWI Post-Processing and Improvements"
version: PLACEHOLDER
date-released: PLACEHOLDER
identifiers:
 - type: "ascl-id"
   value: "2404.003"
 - type: "doi"
   value: PLACEHOLDER
 - type: "bibcode"
   value: "2024ascl.soft04003P"
abstract: "KCWIKit extends the official KCWI DRP (ascl:2301.019) 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."

GitHub Events

Total
  • Create event: 1
  • Issues event: 3
  • Release event: 1
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 26
  • Pull request event: 4
  • Fork event: 3
Last Year
  • Create event: 1
  • Issues event: 3
  • Release event: 1
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 26
  • Pull request event: 4
  • Fork event: 3