VLT/SPHERE
==========
<img src="https://img.shields.io/badge/Python->3.5-yellow.svg?style=flat"> [<img src="https://img.shields.io/pypi/v/vlt-sphere?color=brightgreen">](https://pypi.org/project/vlt-sphere/) [<img src="https://img.shields.io/github/v/release/avigan/SPHERE?color=red">](https://github.com/avigan/SPHERE/releases/latest/) [<img src="https://img.shields.io/github/release-date/avigan/SPHERE">](https://github.com/avigan/SPHERE/releases/latest/) [<img src="https://img.shields.io/github/license/avigan/SPHERE?color=blue">](https://github.com/avigan/SPHERE/blob/master/LICENSE) [<img src="https://img.shields.io/badge/ascl-2009.002-blue.svg?colorB=262255" alt="ascl:2009.002" />](https://ascl.net/2009.002) [<img src="https://img.shields.io/badge/ADS%20reference-Vigan%20(2020)-blueviolet">](https://ui.adsabs.harvard.edu/abs/2020ascl.soft09002V/abstract) [](https://doi.org/10.5281/zenodo.6563998)
Information
-----------
This repository provides tools for the reduction of VLT/SPHERE data. The pipeline currently provides support for processing IRDIS dual-band imaging (DBI), IRDIS classical imaging (CI), IRDIS long-slit spectroscopy (LSS) and IFS data. IRDIS dual-polarimetry imaging (DPI) and ZIMPOL are not supported at the moment.
If you find a bug or want to suggest improvements, please [create a ticket](https://github.com/avigan/SPHERE/issues).
Requirements
------------
The pipeline requires official [ESO pipeline for SPHERE](https://www.eso.org/sci/software/pipelines/) to be installed and in your path. If the `esorex` command is not available the pipeline will output an error.
The package also relies on usual packages for data science and astronomy: [numpy](https://numpy.org/), [scipy](https://www.scipy.org/), [pandas](https://pandas.pydata.org/), [matplotlib](https://matplotlib.org/) and [astropy](https://www.astropy.org/).
Installation
------------
The easiest is to install `sphere` using `pip`:
```sh
pip install vlt-sphere
```
Otherwise your can download the current repository and install the package manually:
```sh
cd SPHERE-master/
python setup.py install
```
Examples
--------
The package is not fully documented, but [examples are provided](https://github.com/avigan/SPHERE/tree/master/examples).
Credits
-------
Please cite the following reference if you use this pipeline in a scientific publication:
* [Vigan, 2020, ASCL, ascl:2009.002](https://ui.adsabs.harvard.edu/abs/2020ascl.soft09002V/abstract)
Or simply use the following Bibtex entry:
```
@MISC{2020ascl.soft09002V,
author = {{Vigan}, Arthur},
title = "{vlt-sphere: Automatic VLT/SPHERE data reduction and analysis}",
keywords = {Software},
year = 2020,
month = sep,
doi = {10.5281/zenodo.6563998},
eid = {ascl:2009.002},
pages = {ascl:2009.002},
archivePrefix = {ascl},
eprint = {2009.002},
adsurl = {https://ui.adsabs.harvard.edu/abs/2020ascl.soft09002V},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```
Moreover, the development of the SPHERE instrument has demanded a tremendous effort from many scientists, who have devoted several years of their life to design, build, test and commission the instrument. To recognize this work, we kindly ask you to cite the relevant instrumental papers in your scientific work. The reference papers for the instrument and its observing mode are:
SPHERE:
* General description: [Beuzit et al., 2019, A&A, 631, A155](https://ui.adsabs.harvard.edu/abs/2019A%26A...631A.155B/abstract)
IRDIS:
* General description: [Dohlen et al., 2008, SPIE, 7014](https://ui.adsabs.harvard.edu/#abs/2008SPIE.7014E..3LD/abstract)
* Long-slit spectroscopy mode: [Vigan et al., 2008, A&A, 489, 1345](https://ui.adsabs.harvard.edu/#abs/2008A&A...489.1345V/abstract)
* Dual-Band Imaging mode: [Vigan et al., 2010, MNRAS, 407, 71](https://ui.adsabs.harvard.edu/#abs/2010MNRAS.407...71V/abstract)
* Dual-Polarization Imaging mode: [de Boer et al., 2020, A&A, 633, A63](https://ui.adsabs.harvard.edu/abs/2020A%26A...633A..63D/abstract) & [van Holstein et al., 2020, A&A, 633, A64](https://ui.adsabs.harvard.edu/abs/2020A%26A...633A..64V/abstract)
IFS:
* General description: [Claudi et al., 2008, SPIE, 7014](https://ui.adsabs.harvard.edu/#abs/2008SPIE.7014E..3EC/abstract)
* Performance: [Mesa et al., 2015, A&A, 576, 121](https://ui.adsabs.harvard.edu/#abs/2015A&A...576A.121M/abstract)
We are grateful for your effort, and hope that these tools will contribute to your scientific work and discoveries. Please feel free to report any bug or possible improvement to the author(s).
Author and contributors
-----------------------
Arthur Vigan <[arthur.vigan@lam.fr](mailto:arthur.vigan@lam.fr)>, Laboratoire d'Astrophysique de Marseille / CNRS
With important contributions from:
* Julien Milli (IPAG/UGA): Support of SPARTA files
* Jean-Françoise Sauvage (ONERA): Support of SPARTA files
* Dino Mesa (INAF/OAPD): IFS pre-processing
* ESO personnel in general: SPHERE pipeline and calibration procedures
And small improvements, or bug reports with suggested fix from:
* Wolfgang Brandner (@Rumpelstil)
* Tomas Stolker (@tomasstolker)
* Karthikeyan Singaravelan (@tirkarthi)
* Chen Xie (@ChenXie-astro)
Raw data
{
"_id": null,
"home_page": "https://github.com/avigan/SPHERE",
"name": "vlt-sphere",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "vlt sphere ifs irdis reduction exoplanet pipeline",
"author": "Arthur Vigan",
"author_email": "arthur.vigan@lam.fr",
"download_url": "https://files.pythonhosted.org/packages/54/7b/5d7a58046677fc9a91fc602a21f3b5d780058dfccd0bf09d8ae78078cdcd/vlt_sphere-1.8.tar.gz",
"platform": null,
"description": "VLT/SPHERE\n==========\n\n<img src=\"https://img.shields.io/badge/Python->3.5-yellow.svg?style=flat\"> [<img src=\"https://img.shields.io/pypi/v/vlt-sphere?color=brightgreen\">](https://pypi.org/project/vlt-sphere/) [<img src=\"https://img.shields.io/github/v/release/avigan/SPHERE?color=red\">](https://github.com/avigan/SPHERE/releases/latest/) [<img src=\"https://img.shields.io/github/release-date/avigan/SPHERE\">](https://github.com/avigan/SPHERE/releases/latest/) [<img src=\"https://img.shields.io/github/license/avigan/SPHERE?color=blue\">](https://github.com/avigan/SPHERE/blob/master/LICENSE) [<img src=\"https://img.shields.io/badge/ascl-2009.002-blue.svg?colorB=262255\" alt=\"ascl:2009.002\" />](https://ascl.net/2009.002) [<img src=\"https://img.shields.io/badge/ADS%20reference-Vigan%20(2020)-blueviolet\">](https://ui.adsabs.harvard.edu/abs/2020ascl.soft09002V/abstract) [](https://doi.org/10.5281/zenodo.6563998)\n\nInformation\n-----------\n\nThis repository provides tools for the reduction of VLT/SPHERE data. The pipeline currently provides support for processing IRDIS dual-band imaging (DBI), IRDIS classical imaging (CI), IRDIS long-slit spectroscopy (LSS) and IFS data. IRDIS dual-polarimetry imaging (DPI) and ZIMPOL are not supported at the moment.\n\nIf you find a bug or want to suggest improvements, please [create a ticket](https://github.com/avigan/SPHERE/issues).\n\nRequirements\n------------\n\nThe pipeline requires official [ESO pipeline for SPHERE](https://www.eso.org/sci/software/pipelines/) to be installed and in your path. If the `esorex` command is not available the pipeline will output an error.\n\nThe package also relies on usual packages for data science and astronomy: [numpy](https://numpy.org/), [scipy](https://www.scipy.org/), [pandas](https://pandas.pydata.org/), [matplotlib](https://matplotlib.org/) and [astropy](https://www.astropy.org/).\n\nInstallation\n------------\n\nThe easiest is to install `sphere` using `pip`:\n\n```sh\npip install vlt-sphere\n```\n\nOtherwise your can download the current repository and install the package manually:\n\n```sh\ncd SPHERE-master/\npython setup.py install\n```\n\nExamples\n--------\n\nThe package is not fully documented, but [examples are provided](https://github.com/avigan/SPHERE/tree/master/examples).\n\nCredits\n-------\n\nPlease cite the following reference if you use this pipeline in a scientific publication:\n\n* [Vigan, 2020, ASCL, ascl:2009.002](https://ui.adsabs.harvard.edu/abs/2020ascl.soft09002V/abstract)\n\nOr simply use the following Bibtex entry:\n\n```\n@MISC{2020ascl.soft09002V,\n author = {{Vigan}, Arthur},\n title = \"{vlt-sphere: Automatic VLT/SPHERE data reduction and analysis}\",\n keywords = {Software},\n year = 2020,\n month = sep,\n doi = {10.5281/zenodo.6563998},\n eid = {ascl:2009.002},\n pages = {ascl:2009.002},\narchivePrefix = {ascl},\n eprint = {2009.002},\n adsurl = {https://ui.adsabs.harvard.edu/abs/2020ascl.soft09002V},\n adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n}\n```\n\nMoreover, the development of the SPHERE instrument has demanded a tremendous effort from many scientists, who have devoted several years of their life to design, build, test and commission the instrument. To recognize this work, we kindly ask you to cite the relevant instrumental papers in your scientific work. The reference papers for the instrument and its observing mode are:\n\nSPHERE:\n * General description: [Beuzit et al., 2019, A&A, 631, A155](https://ui.adsabs.harvard.edu/abs/2019A%26A...631A.155B/abstract)\n\nIRDIS:\n * General description: [Dohlen et al., 2008, SPIE, 7014](https://ui.adsabs.harvard.edu/#abs/2008SPIE.7014E..3LD/abstract)\n * Long-slit spectroscopy mode: [Vigan et al., 2008, A&A, 489, 1345](https://ui.adsabs.harvard.edu/#abs/2008A&A...489.1345V/abstract)\n * Dual-Band Imaging mode: [Vigan et al., 2010, MNRAS, 407, 71](https://ui.adsabs.harvard.edu/#abs/2010MNRAS.407...71V/abstract)\n * Dual-Polarization Imaging mode: [de Boer et al., 2020, A&A, 633, A63](https://ui.adsabs.harvard.edu/abs/2020A%26A...633A..63D/abstract) & [van Holstein et al., 2020, A&A, 633, A64](https://ui.adsabs.harvard.edu/abs/2020A%26A...633A..64V/abstract)\n\nIFS:\n * General description: [Claudi et al., 2008, SPIE, 7014](https://ui.adsabs.harvard.edu/#abs/2008SPIE.7014E..3EC/abstract)\n * Performance: [Mesa et al., 2015, A&A, 576, 121](https://ui.adsabs.harvard.edu/#abs/2015A&A...576A.121M/abstract)\n\nWe are grateful for your effort, and hope that these tools will contribute to your scientific work and discoveries. Please feel free to report any bug or possible improvement to the author(s).\n\nAuthor and contributors\n-----------------------\n\nArthur Vigan <[arthur.vigan@lam.fr](mailto:arthur.vigan@lam.fr)>, Laboratoire d'Astrophysique de Marseille / CNRS\n\nWith important contributions from:\n * Julien Milli (IPAG/UGA): Support of SPARTA files\n * Jean-Fran\u00e7oise Sauvage (ONERA): Support of SPARTA files\n * Dino Mesa (INAF/OAPD): IFS pre-processing\n * ESO personnel in general: SPHERE pipeline and calibration procedures\n\nAnd small improvements, or bug reports with suggested fix from:\n * Wolfgang Brandner (@Rumpelstil)\n * Tomas Stolker (@tomasstolker)\n * Karthikeyan Singaravelan (@tirkarthi)\n * Chen Xie (@ChenXie-astro)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Reduction and analysis code for the VLT/SPHERE instrument",
"version": "1.8",
"project_urls": {
"Homepage": "https://github.com/avigan/SPHERE"
},
"split_keywords": [
"vlt",
"sphere",
"ifs",
"irdis",
"reduction",
"exoplanet",
"pipeline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db089600fec1f7680684215b3cc23a52263ed5ff15aac13ef61fa6c60441a149",
"md5": "e513de77c875417caa926408ce60c317",
"sha256": "6e0ba29a2d20870d77f3a1fbea05200bc1e2cc029c49c3e653fd33c7fd2d54e2"
},
"downloads": -1,
"filename": "vlt_sphere-1.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e513de77c875417caa926408ce60c317",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 501433,
"upload_time": "2024-11-19T16:25:29",
"upload_time_iso_8601": "2024-11-19T16:25:29.404737Z",
"url": "https://files.pythonhosted.org/packages/db/08/9600fec1f7680684215b3cc23a52263ed5ff15aac13ef61fa6c60441a149/vlt_sphere-1.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "547b5d7a58046677fc9a91fc602a21f3b5d780058dfccd0bf09d8ae78078cdcd",
"md5": "808ffba898ae7dc0b9a62c88d1b7257f",
"sha256": "f3bd42362bb393cee8c87f968b1071c7642bedda7e848e15ef50a8760f8201ad"
},
"downloads": -1,
"filename": "vlt_sphere-1.8.tar.gz",
"has_sig": false,
"md5_digest": "808ffba898ae7dc0b9a62c88d1b7257f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 496800,
"upload_time": "2024-11-19T16:25:30",
"upload_time_iso_8601": "2024-11-19T16:25:30.884686Z",
"url": "https://files.pythonhosted.org/packages/54/7b/5d7a58046677fc9a91fc602a21f3b5d780058dfccd0bf09d8ae78078cdcd/vlt_sphere-1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 16:25:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "avigan",
"github_project": "SPHERE",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vlt-sphere"
}
JSON
