Skip to content

mrlb05/Nifty4Gemini

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nifty4Gemini

image

Nifty4Gemini's documentation, hosted on ReadtheDocs.

DOI

MIT license.

Nifty4Gemini uses Astropy! Here is a link to the project webpage:

A Python Data Reduction Pipeline for the Gemini-North Near-Infrared Integral Field Spectrometer (NIFS).

Link to the referred paper of the pipeline: https://ui.adsabs.harvard.edu/abs/2019AJ....158..153L/abstract

Full documentation: ReadTheDocs.

This is a new data reduction Python pipeline that uses Astroconda and the Gemini IRAF Package to reduce NIFS data. It offers a complete data reduction process from sorting the data to producing a final flux calibrated and wavelength calibrated combined cube with the full S/N for a science target.

This pipeline is open source and it is supported via the Gemini Data Reduction User Forum.

Any feedback and comments (mbusserolle@gemini.edu) are welcome!

For more details, please read the LICENSE.

How to Submit Bugs and Requests

Very important: do not submit a Gemini help desk ticket!

If you want to report a problem, use the Gemini Data Reduction Forum thread or create an issue in this repo.

Installation

Pre-Requisites

Make sure you have the latest version of Gemini Astroconda installed, have activated an Astroconda environment and have set up PYRAF. You can find instructions for installing Astroconda here. PYRAF can be set up by running the mkiraf command in your "~/iraf" directory.

Installing

From PyPi.org:

pip install nifty4gemini

Installing in Editable Mode

If you want to edit the Nifty source code, it's recommended to install Nifty in editable Mode. First obtain the Nifty source code. You can do this by downloading and unpacking the latest release or cloning this github repository.

Once you have the source code, change to the top level of the source code directory (you should see the setup.py file). Run:

pip install -e .

to install Nifty in editable mode. Now you can edit your copy of the Nifty source code and run it without having to reinstall every time.

Quick Start

To run Nifty4Gemini, getting data reduction parameters from an interactive input session:

runNifty nifsPipeline -i

To run Nifty in full-automatic mode with default input parameters, provide the -f flag and a full local path to the raw data or a Gemini Program ID string (Eg: GN-2013A-Q-62).

runNifty nifsPipeline -f <data_location>

Acknowledgment

Referred paper of the pipeline: https://ui.adsabs.harvard.edu/abs/2019AJ....158..153L/abstract

License

See the LICENSE file in the current directory. Note that downloadFromGeminiPublicArchive does not use the MIT license. Refer to the LICENCE file in the downloadFromGeminiPublicArchive directory to view the appropriate license.