|
6 | 6 | What's New in Photutils 3.0? |
7 | 7 | **************************** |
8 | 8 |
|
| 9 | +Photutils 3.0 is a major release that includes a small number of |
| 10 | +:ref:`breaking changes <whatsnew-3.0-breaking-changes>` alongside |
| 11 | +several :ref:`new deprecations <whatsnew-3.0-deprecations>`. While these |
| 12 | +deprecations will now trigger warning messages, they will not break |
| 13 | +your code. We are intentionally providing a long deprecation period to |
| 14 | +give users ample time to update their code before these features are |
| 15 | +completely removed in version 4.0. Please review the :ref:`API Changes |
| 16 | +<whatsnew-3.0-api-changes>` section before upgrading. |
| 17 | + |
9 | 18 | Here we highlight some of the new functionality of the 3.0 release. |
10 | 19 | In addition to these changes, Photutils 3.0 includes several |
11 | 20 | smaller improvements and bug fixes, which are described in the full |
@@ -451,9 +460,13 @@ and in the ``Notes`` section of each ``to_sky`` and ``to_pixel`` method |
451 | 460 | docstring. |
452 | 461 |
|
453 | 462 |
|
| 463 | +.. _whatsnew-3.0-api-changes: |
| 464 | + |
454 | 465 | API Changes |
455 | 466 | =========== |
456 | 467 |
|
| 468 | +.. _whatsnew-3.0-deprecations: |
| 469 | + |
457 | 470 | New Deprecations |
458 | 471 | ---------------- |
459 | 472 |
|
@@ -843,18 +856,11 @@ For the ``psf`` package, the previously deprecated |
843 | 856 | :class:`~photutils.psf.ImagePSF` instead. |
844 | 857 |
|
845 | 858 |
|
| 859 | +.. _whatsnew-3.0-breaking-changes: |
| 860 | + |
846 | 861 | Breaking Changes |
847 | 862 | ---------------- |
848 | 863 |
|
849 | | -Star Finder ``orientation`` Column Units |
850 | | -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
851 | | - |
852 | | -The ``orientation`` (was ``pa``) column in the output tables |
853 | | -from :class:`~photutils.detection.IRAFStarFinder` and |
854 | | -:class:`~photutils.detection.StarFinder` is now a ``Quantity`` array in |
855 | | -in the range of [0, 360) degrees. |
856 | | - |
857 | | - |
858 | 864 | Consistent Default ``min_separation`` for Star Finders |
859 | 865 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
860 | 866 |
|
@@ -894,7 +900,7 @@ in the range [0, 360) degrees. |
894 | 900 | Star Finder ``pa`` Column Units and Range |
895 | 901 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
896 | 902 |
|
897 | | -The ``pa`` (position angle) column in the output tables |
| 903 | +The ``orientation`` (was ``pa``) column in the output tables |
898 | 904 | from :class:`~photutils.detection.IRAFStarFinder` and |
899 | 905 | :class:`~photutils.detection.StarFinder` is now a ``Quantity`` array in |
900 | 906 | the range of [0, 360) degrees. |
|
0 commit comments