# Goodman High Throughput Spectrograph Data Reduction Pipeline
![Goodman Pipeline](https://github.com/soar-telescope/goodman_pipeline/actions/workflows/python-package.yml/badge.svg)
[![codecov](https://codecov.io/gh/soar-telescope/goodman_pipeline/branch/main/graph/badge.svg)](https://codecov.io/gh/soar-telescope/goodman_pipeline)
[![Documentation Status](https://readthedocs.org/projects/goodman/badge/?version=latest)](http://goodman.readthedocs.io/en/latest/?badge=latest)
[![pypi](https://img.shields.io/pypi/v/goodman_pipeline.svg?style=flat)](https://pypi.org/project/goodman-pipeline/)
[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
![Upload to PYPI](https://github.com/soar-telescope/goodman_pipeline/workflows/Upload%20to%20PYPI/badge.svg)
## Overview
The Goodman High Throughput Spectrograph (Goodman HTS) Data-Reduction Pipeline
is the SOAR Telescope's official data reduction pipeline for *Goodman HTS*.
It has been fully developed in Python and uses mostly astropy affiliated packages
with the exception of [dcr](http://users.camk.edu.pl/pych/DCR/) which is an external tool
that does cosmic ray identification and correction. The reason for using it
instead of LACosmic is that it works very well for spectroscopic data and the
results are evidently superior. Some of the negative aspects of using this
external (meaning outside of Python domains) software were: The integration into
the pipeline's workflow and the use of an external `dcr.par` parameter file.
Such parameters have to be changed by hand and can't be integrated into the
pipeline's workflow itself. In particular for binning 2x2 and custom ROI those
parameters contained in _dcr.par_ has to be specifically tuned.
## Documentation
You will find a user manual on [goodman.readthedocs.org](http://goodman.readthedocs.io/en/latest/)
If you wish to know more about the instrument please check the
[SOAR website](http://www.ctio.noao.edu/soar/content/goodman-high-throughput-spectrograph)
## Having trouble?
If you are having trouble operating the Goodman Pipeline we suggest the following
procedure.
* Check [existing issues](https://github.com/soar-telescope/goodman_pipeline/issues) or
open a [new Issue](https://github.com/soar-telescope/goodman_pipeline/issues/new) on GitHub.
## Development Team
- [Simón Torres](https://github.com/simontorres) (NOIRLab Software Engineer - main code developer)
- [César Briceño](https://github.com/cbaorion) (SOAR Telescope Scientist - team lead)
- [Bruno Quint](https://github.com/b1quint) (Brazil Support Astronomer - code development adviser)
## Acknowledgements
We acknowledge the important contribution of [David Sanmartim](https://github.com/dsanmartim), who developed
the initial incarnation of the redccd module. We thank [Tina Armond](https://github.com/tarmond) for her
invaluable help in adding calibrated comparison lamps to the [library](https://goodman.readthedocs.io/projects/lamps/en/latest/) of
reference comparison lamps for wavelength solution.
Our work would not be possible without the friendly work atmosphere at CTIO
headquarters in La Serena, were we can interact with our SOAR and CTIO
colleagues in lively and useful discussions that have been important in making
the Goodman pipeline possible. We also acknowledge fruitful discussions and
suggestions from our colleagues Bart Dunlop, Chris Clemens, and Erik Dennihy,
at University of North Carolina at Chapel Hill.
## Citations:
This pipeline makes extensive use of Astropy therefore you should cite as suggested
on [Astropy Citation Page](https://github.com/astropy/astropy/blob/master/CITATION) as follows:
This research made use of Astropy, a community-developed core Python package
for Astronomy (Astropy Collaboration, 2013, 2018).
It also uses [DCR](http://users.camk.edu.pl/pych/DCR/) for cosmic rays identification
and removal. You should cite [this paper](http://adsabs.harvard.edu/abs/2004PASP..116..148P)
Pych, W., 2004, PASP, 116, 148
Raw data
{
"_id": null,
"home_page": "https://github.com/soar-telescope/goodman_pipeline",
"name": "goodman-pipeline",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "soar pipelines astronomy images spectroscopy",
"author": "Simon Torres R., Bruno Quint, Cesar Brice\u00f1o, David Sanmartin,",
"author_email": "storres@ctio.noao.edu, bquint@ctio.noao.edu, cbriceno@ctio.noao.edu",
"download_url": "https://files.pythonhosted.org/packages/a4/ee/22807b8bd6a148e6e3d87d1b59a02287afade51a6e17c90985732392a817/goodman_pipeline-1.3.7.tar.gz",
"platform": null,
"description": "# Goodman High Throughput Spectrograph Data Reduction Pipeline\n\n![Goodman Pipeline](https://github.com/soar-telescope/goodman_pipeline/actions/workflows/python-package.yml/badge.svg)\n[![codecov](https://codecov.io/gh/soar-telescope/goodman_pipeline/branch/main/graph/badge.svg)](https://codecov.io/gh/soar-telescope/goodman_pipeline)\n[![Documentation Status](https://readthedocs.org/projects/goodman/badge/?version=latest)](http://goodman.readthedocs.io/en/latest/?badge=latest)\n[![pypi](https://img.shields.io/pypi/v/goodman_pipeline.svg?style=flat)](https://pypi.org/project/goodman-pipeline/)\n[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)\n\n\n![Upload to PYPI](https://github.com/soar-telescope/goodman_pipeline/workflows/Upload%20to%20PYPI/badge.svg)\n\n\n## Overview\nThe Goodman High Throughput Spectrograph (Goodman HTS) Data-Reduction Pipeline\nis the SOAR Telescope's official data reduction pipeline for *Goodman HTS*.\n\nIt has been fully developed in Python and uses mostly astropy affiliated packages\nwith the exception of [dcr](http://users.camk.edu.pl/pych/DCR/) which is an external tool\nthat does cosmic ray identification and correction. The reason for using it\ninstead of LACosmic is that it works very well for spectroscopic data and the\nresults are evidently superior. Some of the negative aspects of using this\nexternal (meaning outside of Python domains) software were: The integration into\nthe pipeline's workflow and the use of an external `dcr.par` parameter file.\n Such parameters have to be changed by hand and can't be integrated into the\n pipeline's workflow itself. In particular for binning 2x2 and custom ROI those\n parameters contained in _dcr.par_ has to be specifically tuned.\n\n## Documentation\n\nYou will find a user manual on [goodman.readthedocs.org](http://goodman.readthedocs.io/en/latest/)\n\nIf you wish to know more about the instrument please check the \n[SOAR website](http://www.ctio.noao.edu/soar/content/goodman-high-throughput-spectrograph)\n\n## Having trouble?\n\nIf you are having trouble operating the Goodman Pipeline we suggest the following\nprocedure.\n\n* Check [existing issues](https://github.com/soar-telescope/goodman_pipeline/issues) or \nopen a [new Issue](https://github.com/soar-telescope/goodman_pipeline/issues/new) on GitHub.\n\n## Development Team\n\n- [Sim\u00f3n Torres](https://github.com/simontorres) (NOIRLab Software Engineer - main code developer)\n- [C\u00e9sar Brice\u00f1o](https://github.com/cbaorion) (SOAR Telescope Scientist - team lead)\n- [Bruno Quint](https://github.com/b1quint) (Brazil Support Astronomer - code development adviser)\n\n\n## Acknowledgements\n\nWe acknowledge the important contribution of [David Sanmartim](https://github.com/dsanmartim), who developed\nthe initial incarnation of the redccd module. We thank [Tina Armond](https://github.com/tarmond) for her\ninvaluable help in adding calibrated comparison lamps to the [library](https://goodman.readthedocs.io/projects/lamps/en/latest/) of\nreference comparison lamps for wavelength solution.\n\nOur work would not be possible without the friendly work atmosphere at CTIO\nheadquarters in La Serena, were we can interact with our SOAR and CTIO\ncolleagues in lively and useful discussions that have been important in making\nthe Goodman pipeline possible. We also acknowledge fruitful discussions and\nsuggestions from our colleagues Bart Dunlop, Chris Clemens, and Erik Dennihy,\nat University of North Carolina at Chapel Hill.\n \n## Citations:\n This pipeline makes extensive use of Astropy therefore you should cite as suggested\n on [Astropy Citation Page](https://github.com/astropy/astropy/blob/master/CITATION) as follows:\n \n This research made use of Astropy, a community-developed core Python package\n for Astronomy (Astropy Collaboration, 2013, 2018).\n \n It also uses [DCR](http://users.camk.edu.pl/pych/DCR/) for cosmic rays identification\n and removal. You should cite [this paper](http://adsabs.harvard.edu/abs/2004PASP..116..148P)\n \n Pych, W., 2004, PASP, 116, 148\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Pipeline for reducing Goodman HTS data.",
"version": "1.3.7",
"project_urls": {
"Homepage": "https://github.com/soar-telescope/goodman_pipeline"
},
"split_keywords": [
"soar",
"pipelines",
"astronomy",
"images",
"spectroscopy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14ed9d90972fcbd4dcb1be7e8ab616d2ad775b271830b0c967cf2eb769000549",
"md5": "f9ef35af250312eb91ee9a2d14ce5198",
"sha256": "91b4b65123f808431f28fc5145182d9eeb6b2dd97fddb346496568cb25799c39"
},
"downloads": -1,
"filename": "goodman_pipeline-1.3.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9ef35af250312eb91ee9a2d14ce5198",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43020799,
"upload_time": "2023-08-17T23:10:07",
"upload_time_iso_8601": "2023-08-17T23:10:07.582446Z",
"url": "https://files.pythonhosted.org/packages/14/ed/9d90972fcbd4dcb1be7e8ab616d2ad775b271830b0c967cf2eb769000549/goodman_pipeline-1.3.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4ee22807b8bd6a148e6e3d87d1b59a02287afade51a6e17c90985732392a817",
"md5": "67391abcceb25e4de1cc3a65a6faf821",
"sha256": "df9b6219e6187c6ca300b5ae88092d1ea37df952e31f71e963ebd46e67080598"
},
"downloads": -1,
"filename": "goodman_pipeline-1.3.7.tar.gz",
"has_sig": false,
"md5_digest": "67391abcceb25e4de1cc3a65a6faf821",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 42634389,
"upload_time": "2023-08-17T23:10:12",
"upload_time_iso_8601": "2023-08-17T23:10:12.213730Z",
"url": "https://files.pythonhosted.org/packages/a4/ee/22807b8bd6a148e6e3d87d1b59a02287afade51a6e17c90985732392a817/goodman_pipeline-1.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-17 23:10:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soar-telescope",
"github_project": "goodman_pipeline",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "goodman-pipeline"
}