Skip to content

Commit

Permalink
Preparation for release v1.3.5
Browse files Browse the repository at this point in the history
  • Loading branch information
robvanholstein committed Jul 1, 2023
1 parent d00e097 commit a70b78c
Show file tree
Hide file tree
Showing 42 changed files with 918 additions and 970 deletions.
20 changes: 10 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.. |stars| image:: https://img.shields.io/github/stars/robvanholstein/IRDAP.svg?style=social&label=Stars
:target: https://github.com/robvanholstein/IRDAP/

.. |watch| image:: https://img.shields.io/github/watchers/robvanholstein/IRDAP.svg?style=social&label=Watch
:target: https://github.com/robvanholstein/IRDAP/

.. |pypi| image:: https://img.shields.io/pypi/v/irdap.svg?colorB=<brightgreen>
:target: https://pypi.python.org/pypi/irdap/

.. |python| image:: https://img.shields.io/badge/Python-3.6%2C%203.7-yellow.svg?style=flat
:target: https://pypi.python.org/pypi/irdap/

.. |github| image:: https://img.shields.io/github/release/robvanholstein/IRDAP.svg
:target: https://github.com/robvanholstein/IRDAP/
:target: https://github.com/robvanholstein/IRDAP/

.. |last-commit| image:: https://img.shields.io/github/last-commit/robvanholstein/IRDAP.svg?colorB=e6c000
:target: https://github.com/robvanholstein/IRDAP/

Expand All @@ -24,17 +24,17 @@

.. |ads2| image:: https://img.shields.io/badge/ADS-van%20Holstein%20et%20al.%20(2017)-blueviolet.svg
:target: https://ui.adsabs.harvard.edu/abs/2017SPIE10400E..15V

.. Made ads-link above on https://shields.io/ with "your badge"
.. IRDAP |stars| |watch|
IRDAP
=====

|pypi| |python| |github| |last-commit| |license| |ads1| |ads2|

**IRDAP (IRDIS Data reduction for Accurate Polarimetry) is a highly-automated end-to-end pipeline to reduce SPHERE-IRDIS polarimetric data that is written for Python 3.6 and 3.7.**
**IRDAP (IRDIS Data reduction for Accurate Polarimetry) is a highly-automated end-to-end pipeline to reduce SPHERE-IRDIS polarimetric data that is written for Python 3.6 and higher.**

Copyright (C) 2019 R.G. van Holstein

Expand All @@ -43,5 +43,5 @@ Full documentation: https://irdap.readthedocs.io
Feedback, questions, comments: send an e-mail to `Rob van Holstein <[email protected]>`_.

When publishing data reduced with IRDAP, please cite `van Holstein et al. (2020) <https://ui.adsabs.harvard.edu/abs/2020A%26A...633A..64V/abstract>`_. For data in pupil-tracking mode please additionally cite `van Holstein et al. (2017) <https://ui.adsabs.harvard.edu/abs/2017SPIE10400E..15V>`_.
IRDAP is distributed under the GNU General Public License v3. See the `LICENSE file <https://github.com/robvanholstein/IRDAP/blob/master/LICENSE>`_ for the precise terms and conditions.

IRDAP is distributed under the GNU General Public License v3. See the `LICENSE file <https://github.com/robvanholstein/IRDAP/blob/master/LICENSE>`_ for the precise terms and conditions.
Binary file modified docs/build/doctrees/acknowledgements.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/citing.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/configfile.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/contributing.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/example.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/instructions.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/mailinglist.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 527bef6e76f13227f3e0f7c6a1b9c3ab
config: 138842a9e84d459a24475d8523c7615c
tags: 645f666f9bcd5a90fca523b33c5a78b7
39 changes: 22 additions & 17 deletions docs/build/html/_sources/changelog.rst.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

.. |last-commit| image:: https://img.shields.io/github/last-commit/robvanholstein/IRDAP.svg?colorB=e6c000
:target: https://github.com/robvanholstein/IRDAP/

.. |issues| image:: https://img.shields.io/github/issues/robvanholstein/IRDAP.svg?color=b4001e
:target: https://github.com/robvanholstein/IRDAP/issues

Expand All @@ -14,12 +14,17 @@ Changelog & to-do
Changelog
---------

v1.3.5 July 2023, R.G. van Holstein
- Corrected errors due to numpy.int being deprecated
- Added a warning that IP model is currently not completely accurate
- Minor corrections

v1.3.4 May 2022, R.G. van Holstein
- Corrected an error due to a scikit-image function being deprecated

v1.3.3 June 2021, R.G. van Holstein
- Updated code so that it correctly handles the change of the header names INS4 DROT2 BEGIN and INS4 DROT3 BEGIN to INS4 DROT2 START and INS4 DROT3 START in the FITS files

v1.3.2 January 2021, R.G. van Holstein
- Corrected a bug that prevented reductions to be performed when dark and flat files are included in the raw subdirectory

Expand All @@ -41,31 +46,31 @@ v1.2.3 December 2019, R.G. van Holstein
- Very minor correction to computation of HWP angle from headers
- Corrected minor bug when computing polarimetric efficiency when the number of Q and U cycles is unequal
- Added warning when spread of star polarization per HWP cycle is large and suggest to try normalized double difference

v1.2.2 November 2019, R.G. van Holstein
- Added polarimetric efficiency to crosstalk/transmission plot, a print statement with the range of the polarimetric efficiency of the observations, and a warning in case of low polarimetric efficiency
- Corrected a bug in the checks of flux_annulus_star
- Corrected a bug that when mean combining ADI+PCA-images only the first frame of the cube was written to the FITS-files

v1.2.1 November 2019, R.G. van Holstein
- Corrected bug introduced in v1.2.0 with computation of DoLP and AoLP of star when there is an unequal number of Q and U measurements

v1.2.0 November 2019, R.G. van Holstein
- Added computation of statistical uncertainty (photon and background noise) on measured star polarization in PDI part
- Added contrast curves for the detection of polarized extended sources and polarized point source with PDI

v1.1.0 October 2019, R.G. van Holstein & J. Milli
- Added angular differential imaging (ADI) including principal component analysis (PCA) of total intensity images for pupil-tracking observations
- Added mean combination of ADI final images to command-line option :code:`irdap --meancombine`

v1.0.0 September 2019, R.G. van Holstein & J. Milli:
- No backward compatibility with previous versions
- Added analysis of master flux frames to enable the user to express the final images in contrast/arcsec^2 or Jansky/arcsec^2
- Restructered code and configuration file to allow for the separate execution of pre-processing, polarimetric differential imaging (previously referred to as post-processing) and angular differential imaging
- Restructered code and configuration file to allow for the separate execution of pre-processing, polarimetric differential imaging (previously referred to as post-processing) and angular differential imaging
- Added plot of center coordinates of center frames vs time
- Added possibility to open documentation through terminal command :code:`irdap --website`
- Confirmed that polarimetric data with dithering applied is correctly reduced

v0.3.0 July 2019, R.G. van Holstein:
- Added command-line option :code:`irdap --meancombine` to mean-combine final images of multiple observation blocks

Expand All @@ -75,11 +80,11 @@ v0.2.1 June 2019, R.G. van Holstein:
v0.2.0 June 2019, R.G. van Holstein:
- Changed the definition of the tuple of the input parameters *annulus_star*, *annulus_background* and *flux_annulus_background*: *width* is replaced by *outer_radius* and the definition of *start_angle* and *end_angle* is now the same as in DS9
- Replaced static flat in Ks by one with P0-90 inserted

v0.1.2 June 2019, R.G. van Holstein:
- Release of IRDAP package on PyPI and GitHub
- Documentation put online

To-do high priority
-------------------
- Add possibility to reduce data with center frames having a different DIT than the object frames (i.e. automatically scale object frames to DIT and ND filter of center frames before subtracting it; test with data of HD142527)
Expand All @@ -97,22 +102,22 @@ To-do high priority
- Add accurate (calibrated) model correction for narrowband filters
- Add option to apply accurate plate scale and distortion correction for data (especially important for pupil-tracking and bright sources; do we need calibrations?)
- For pupil-tracking data mask bad pixel clusters when computing least squares solution to get rid off sectors of bad data; for field-tracking data set bad pixel clusters to NaN.

To-do low priority
------------------

- Add computation of mean stellar polarization and uncertainty when mean-combining data sets
- Add images and plots aimed at analysis of polarimetric data (R^2 scaling, AoLP arrows in polarized intensity or DoLP images), maybe using terminal commands.
- Add images and plots aimed at analysis of polarimetric data (R^2 scaling, AoLP arrows in polarized intensity or DoLP images), maybe using terminal commands.
- Add option to subtract DARK,BACKGROUND-frames if sky files are lacking (especially important for Ks; test effect first before completely implementing)
- Add option to scale the master sky frame to subtract from the object frames (especially for Ks; see also Gallicher et al. 2011)
- Add option for 'stupid ADI' for field-tracking data with derotator offset and option to subtract 180 deg rotated image if no derotator offset
- Create contrast curves of final ADI-images
- Make figures with sub-images horizontal, or make multiple lines of left and right images in a single figure
- Create contrast curves of final ADI-images
- Make figures with sub-images horizontal, or make multiple lines of left and right images in a single figure
- Add options for various methods to shift and rotate images (interpolate, ndimage-fourier, sci-image functions; similar to VIP)
- Improve centering of non-coronagraphic data (center found depends a lot on first PSF and affects Qphi and Uphi images). Perhaps fit coordinates on each PSF, but do the actual shifts with the mean of these fitted values. This has proven to give a more accurate final result.
- Improve centering of non-coronagraphic data (center found depends a lot on first PSF and affects Qphi and Uphi images). Perhaps fit coordinates on each PSF, but do the actual shifts with the mean of these fitted values. This has proven to give a more accurate final result.
- Add centering method that minimizes the SSR of the left minus right frames in an aperture centered on the star
- Test finding of satellite spots of center files when waffle pattern is '+'
- Add weighted least-squares as option for model correction (depending on image quality or polarimetric efficiency)
- Add weighted least-squares as option for model correction (depending on image quality or polarimetric efficiency)
- Exclude saturated pixels in aperture to determine star polarization (same way as used in function fit_2d_gaussian)
- Determine star polarization as a function of aperture radius
- Add optional RDI for total intensity images
- Determine star polarization as a function of aperture radius
- Add optional RDI for total intensity images
2 changes: 1 addition & 1 deletion docs/build/html/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Installation
============

To run IRDAP the user needs to have Python 3.6 or 3.7 installed.
To run IRDAP the user needs to have Python 3.6 or higher installed.

Installing IRDAP
----------------
Expand Down
59 changes: 29 additions & 30 deletions docs/build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
min-width: 360px;
max-width: 800px;
}

Expand All @@ -237,16 +237,6 @@ a.headerlink {
visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -335,12 +325,16 @@ p.sidebar-title {
font-weight: bold;
}

nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -379,13 +373,17 @@ div.body p.centered {

div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -428,10 +426,6 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
border: 0 !important;
}

th {
text-align: left;
padding-right: 5px;
Expand Down Expand Up @@ -615,19 +609,26 @@ ul.simple p {
margin-bottom: 0;
}

dl.footnote > dt,
dl.citation > dt {
aside.footnote > span,
div.citation > span {
float: left;
margin-right: 0.5em;
}

dl.footnote > dd,
dl.citation > dd {
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
Expand All @@ -644,10 +645,6 @@ dl.field-list > dt {
padding-right: 5px;
}

dl.field-list > dt:after {
content: ":";
}

dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
Expand Down Expand Up @@ -731,8 +728,9 @@ dl.glossary dt {

.classifier:before {
font-style: normal;
margin: 0.5em;
margin: 0 0.5em;
content: ":";
display: inline-block;
}

abbr, acronym {
Expand All @@ -756,6 +754,7 @@ span.pre {
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}

div[class*="highlight-"] {
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_static/css/badge_only.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a70b78c

Please sign in to comment.