Repository navigation
Releases
v7.0
6.0.0 (2024-07-19)
Breaking Changes
-
Arguments for
~sunpy.map.GenericMap.reproject_toafter the target WCS are now keyword-only. (#7339) -
Arguments for
sunpy.timeseries.GenericTimeSeries.peekare now keywords only. (#7340) -
Removed scikit-image from the "image" extra group and created a new "scikit-image" extra group. (#7536)
-
The "all" extra group now will install all optional packages.
This now includes the following packages:
- asdf
- glmyur
- opencv
- scikit-image
- spiceypy (#7536)
-
Removed the "dask" extra group. (#7536)
-
sunpy.io.read_fileandsunpy.io.write_fileare deprecated and will be removed in the future. These were intended to be private functions and should not be used. (#7537) -
The ANA C code has been deprecated (<span class="title-ref">sunpy.io.ana.read</span>, <span class="title-ref">sunpy.io.ana.get_header</span>, <span class="title-ref">sunpy.io.ana.write</span>) and may be removed in a future sunpy release. Please contact us here: <https://community.openastronomy.org/t/possible-deprecation-of-ana-file-readers-and-writers-in-sunpy> if you are making use of this code. (#7642)
-
The <span class="title-ref">.EUIMap</span> class now returns the
DATE-BEGkey for <span class="title-ref">.GenericMap.date</span> while continuing to useDATE-AVGas the reference date for the coordinate system. (#7682) -
The <span class="title-ref">.GenericMap.date</span> key priority order has changed to be consistent with it representing the "canonical" observation time.
DATE-OBScontinues to have the highest priority, but nowDATE-BEGhas higher priority thanDATE-AVG. (#7682) -
A new property <span class="title-ref">.GenericMap.reference_date</span> has been added to decouple the reference date for the coordinate system from the "canonical" observation time. This new property is now passed through to the map's WCS object as
dateavgand is the time used for <span class="title-ref">.GenericMap.coordinate_frame</span> and <span class="title-ref">.GenericMap.observer_coordinate</span>. (#7682)
Deprecations
~sunpy.coordinates.Helioprojective.assume_spherical_screenhas been deprecated in favor of <span class="title-ref">~sunpy.coordinates.SphericalScreen</span>. (#7115)sunpy.physics.differential_rotation.diff_rothas been deprecated and replaced bysunpy.sun.models.differential_rotation. (#7409)- Deprecated all positional arguments in
sunpy.map.GenericMap.plotmethod. Theannotate,axes,title,clip_intervalarguments should be passed as keyword arguments (e.g.,..., title=True, ...) instead. (#7421) - The keyword
response_formatinsunpy.net.vso.VSOClient.searchhas been deprecated. This was introduced to preserve legacy behaviour of the VSO client, to returnsunpy.net.vso.legacy_response.QueryResponseinstead of <span class="title-ref">sunpy.net.vso.table_response.VSOQueryResponseTable</span> objects. This behaviour has been the default for over 4 years and the keyword is no longer needed. This keyword and the oldersunpy.net.vso.legacy_response.QueryResponseclass will be removed in sunpy 7.0. The keywordprogressinsunpy.net.hek2vso.H2VClient.full_queryhas been deprecated and will be removed in sunpy 7.0. (#7468)
Removals
sunpy.databasehas been removed. (#7320)sunpy.map.header_helper.meta_keywordshas been removed. (#7337)sunpy.net.helioviewer.HelioviewerClienthas been removed. Use the hvpy package instead. (#7338)- There was a private "Maxwell" unit within <span class="title-ref">sunpy.map</span> to register it before astropy had support for it. This has now been removed in favour of using the astropy version. (#7383)
New Features
-
sunpy.io.read_filewill now try to detect the filetype based on the content and then fallback to using the file extension. (#6736) -
It is now possible to read the comments in a header from a JPEG2000 file. (#6841)
-
Added the ability for <span class="title-ref">sunpy.map.Map</span> to load files from a generator. (#7024)
-
Added <span class="title-ref">~sunpy.coordinates.PlanarScreen</span> for interpreting 2D <span class="title-ref">~sunpy.coordinates.Helioprojective</span> coordinates as being on the inside of a planar screen. (#7115)
-
Added the ability to pass
clip_intervaltosunpy.map.mapsequence.MapSequence.plot. (#7253) -
Add support for the
fillkeyword in~sunpy.map.GenericMap.draw_contoursto allow for filled contours. (#7281) -
~sunpy.coordinates.get_horizons_coordnow supports time arrays with up to 10,000 elements. (#7319) -
Add an example of plotting a rectangle on a map with a rotation angle relative to the axes (
sphx_glr_generated_gallery_plotting_plot_rotated_rectangle.py). (#7348) -
Added testing and explicit support for Python 3.12. (#7351)
-
Added warning when importing a submodule without installing that submodules extra dependencies. (#7369)
-
Added a warning message for
rsunmismatch in~sunpy.map.GenericMap.reproject_tomethod. (#7370) -
Added a new optional extra group to install "opencv" if you want to it for affine transforms.
pip install sunpy[opencv] (`#7383 <https://github.com/sunpy/sunpy/pull/7383>`__) -
Increased minimum versions for:
- asdf >= 2.12.0
- asdf-astropy >= 0.2.0
- astropy >= 5.2.0
- beautifulsoup4 >= 4.11.0
- cdflib >= 0.4.4
- dask >= 2022.5.2
- h5netcdf > =1.0.0
- h5py >= 3.7.0
- lxml >= 4.9.0
- opencv-python >= 4.6.0.66
- pandas >= 1.4.0
- python >= 3.10
- reproject >= 0.9.0
- requests >= 2.28.0
- scikit-image >= 0.19.0
- scipy >= 1.8.0
- spiceypy >= 5.0.0
- tqdm >= 4.64.0
- zeep >= 4.1.0 (#7383)
-
sunpy.map.GenericMap.draw_contoursdon't run internal transform code iftransformkeyword is provided. (#7427) -
Update ASDF schemas for upcoming ASDF standard 1.6.0. (#7432)
-
Add a new map source <span class="title-ref">~sunpy.map.sources.gong.GONGHalphaMap</span> for GONG H-Alpha data. (#7451)
-
Added
~sunpy.coordinates.spice.get_rotation_matrixto obtain the rotation matrix between the orientations of two SPICE frames, which is particularly useful for transforming vector fields. (#7452) -
Allow units to be passed to <span class="title-ref">~sunpy.map.header_helper.make_fitswcs_header</span> as strings. (#7454)
-
A new client (<span class="title-ref">sunpy.net.dataretriever.ADAPTClient</span>) has been added to search and download ADAPT files. (#7463)
-
<span class="title-ref">sunpy.net.jsoc.JSOCClient</span> queries now return the SUMS directory paths as the segment key value in the results table. (#7469)
-
Allow the screen radius to be set when using <span class="title-ref">~sunpy.coordinates.SphericalScreen</span>. (#7532)
-
Added a "core" extra group that does not install any truly optional dependencies. It only includes the dependencies that are required to import sunpy and all subpackages.
This means it will not install:
- asdf
- glymur
- opencv
- scikit-image
- spiceypy (#7536)
-
Updated
sunpy.map.GenericMap.submapto check if it is about to work on locations with NaNs now errors and informs the user that they likely want to use~sunpy.coordinates.Helioprojective.assume_spherical_screenso that the off-disk 2D coordinate can be converted to a 3D coordinate. (#7543) -
<span class="title-ref">~sunpy.map.GenericMap</span> will now assign units of DN without a warning or error. (#7585)
-
Add a new map source <span class="title-ref">~sunpy.map.sources.ADAPTMap</span> for ADvanced Adaptive Prediction Technique (ADAPT) data files. (#7640)
-
Added support for JSOC's HMI millisecond TAI time format. Previousl...
Release v6.0.1.3
6.0.0 (2024-07-19)
Breaking Changes
-
Arguments for
~sunpy.map.GenericMap.reproject_toafter the target WCS are now keyword-only. (#7339) -
Arguments for
sunpy.timeseries.GenericTimeSeries.peekare now keywords only. (#7340) -
Removed scikit-image from the "image" extra group and created a new "scikit-image" extra group. (#7536)
-
The "all" extra group now will install all optional packages.
This now includes the following packages:
- asdf
- glmyur
- opencv
- scikit-image
- spiceypy (#7536)
-
Removed the "dask" extra group. (#7536)
-
sunpy.io.read_fileandsunpy.io.write_fileare deprecated and will be removed in the future. These were intended to be private functions and should not be used. (#7537) -
The ANA C code has been deprecated (sunpy.io.ana.read, sunpy.io.ana.get_header, sunpy.io.ana.write) and may be removed in a future sunpy release. Please contact us here: https://community.openastronomy.org/t/possible-deprecation-of-ana-file-readers-and-writers-in-sunpy if you are making use of this code. (#7642)
-
The .EUIMap class now returns the
DATE-BEGkey for .GenericMap.date while continuing to useDATE-AVGas the reference date for the coordinate system. (#7682) -
The .GenericMap.date key priority order has changed to be consistent with it representing the "canonical" observation time.
DATE-OBScontinues to have the highest priority, but nowDATE-BEGhas higher priority thanDATE-AVG. (#7682) -
A new property .GenericMap.reference_date has been added to decouple the reference date for the coordinate system from the "canonical" observation time. This new property is now passed through to the map's WCS object as
dateavgand is the time used for .GenericMap.coordinate_frame and .GenericMap.observer_coordinate. (#7682)
Deprecations
~sunpy.coordinates.Helioprojective.assume_spherical_screenhas been deprecated in favor of ~sunpy.coordinates.SphericalScreen. (#7115)sunpy.physics.differential_rotation.diff_rothas been deprecated and replaced bysunpy.sun.models.differential_rotation. (#7409)- Deprecated all positional arguments in
sunpy.map.GenericMap.plotmethod. Theannotate,axes,title,clip_intervalarguments should be passed as keyword arguments (e.g.,..., title=True, ...) instead. (#7421) - The keyword
response_formatinsunpy.net.vso.VSOClient.searchhas been deprecated. This was introduced to preserve legacy behaviour of the VSO client, to returnsunpy.net.vso.legacy_response.QueryResponseinstead of sunpy.net.vso.table_response.VSOQueryResponseTable objects. This behaviour has been the default for over 4 years and the keyword is no longer needed. This keyword and the oldersunpy.net.vso.legacy_response.QueryResponseclass will be removed in sunpy 7.0. The keywordprogressinsunpy.net.hek2vso.H2VClient.full_queryhas been deprecated and will be removed in sunpy 7.0. (#7468)
Removals
sunpy.databasehas been removed. (#7320)sunpy.map.header_helper.meta_keywordshas been removed. (#7337)sunpy.net.helioviewer.HelioviewerClienthas been removed. Use the hvpy package instead. (#7338)- There was a private "Maxwell" unit within sunpy.map to register it before astropy had support for it. This has now been removed in favour of using the astropy version. (#7383)
New Features
-
sunpy.io.read_filewill now try to detect the filetype based on the content and then fallback to using the file extension. (#6736) -
It is now possible to read the comments in a header from a JPEG2000 file. (#6841)
-
Added the ability for sunpy.map.Map to load files from a generator. (#7024)
-
Added ~sunpy.coordinates.PlanarScreen for interpreting 2D ~sunpy.coordinates.Helioprojective coordinates as being on the inside of a planar screen. (#7115)
-
Added the ability to pass
clip_intervaltosunpy.map.mapsequence.MapSequence.plot. (#7253) -
Add support for the
fillkeyword in~sunpy.map.GenericMap.draw_contoursto allow for filled contours. (#7281) -
~sunpy.coordinates.get_horizons_coordnow supports time arrays with up to 10,000 elements. (#7319) -
Add an example of plotting a rectangle on a map with a rotation angle relative to the axes (
sphx_glr_generated_gallery_plotting_plot_rotated_rectangle.py). (#7348) -
Added testing and explicit support for Python 3.12. (#7351)
-
Added warning when importing a submodule without installing that submodules extra dependencies. (#7369)
-
Added a warning message for
rsunmismatch in~sunpy.map.GenericMap.reproject_tomethod. (#7370) -
Added a new optional extra group to install "opencv" if you want to it for affine transforms.
pip install sunpy[opencv] (`#7383 <https://github.com/sunpy/sunpy/pull/7383>`__) -
Increased minimum versions for:
- asdf >= 2.12.0
- asdf-astropy >= 0.2.0
- astropy >= 5.2.0
- beautifulsoup4 >= 4.11.0
- cdflib >= 0.4.4
- dask >= 2022.5.2
- h5netcdf > =1.0.0
- h5py >= 3.7.0
- lxml >= 4.9.0
- opencv-python >= 4.6.0.66
- pandas >= 1.4.0
- python >= 3.10
- reproject >= 0.9.0
- requests >= 2.28.0
- scikit-image >= 0.19.0
- scipy >= 1.8.0
- spiceypy >= 5.0.0
- tqdm >= 4.64.0
- zeep >= 4.1.0 (#7383)
-
sunpy.map.GenericMap.draw_contoursdon't run internal transform code iftransformkeyword is provided. (#7427) -
Update ASDF schemas for upcoming ASDF standard 1.6.0. (#7432)
-
Add a new map source ~sunpy.map.sources.gong.GONGHalphaMap for GONG H-Alpha data. (#7451)
-
Added
~sunpy.coordinates.spice.get_rotation_matrixto obtain the rotation matrix between the orientations of two SPICE frames, which is particularly useful for transforming vector fields. (#7452) -
Allow units to be passed to ~sunpy.map.header_helper.make_fitswcs_header as strings. (#7454)
-
A new client (sunpy.net.dataretriever.ADAPTClient) has been added to search and download ADAPT files. (#7463)
-
sunpy.net.jsoc.JSOCClient queries now return the SUMS directory paths as the segment key value in the results table. (#7469)
-
Allow the screen radius to be set when using ~sunpy.coordinates.SphericalScreen. (#7532)
-
Added a "core" extra group that does not install any truly optional dependencies. It only includes the dependencies that are required to import sunpy and all subpackages.
This means it will not install:
- asdf
- glymur
- opencv
- scikit-image
- spiceypy (#7536)
-
Updated
sunpy.map.GenericMap.submapto check if it is about to work on locations with NaNs now errors and informs the user that they likely want to use~sunpy.coordinates.Helioprojective.assume_spherical_screenso that the off-disk 2D coordinate can be converted to a 3D coordinate. (#7543) -
~sunpy.map.GenericMap will now assign units of DN without a warning or error. (#7585)
-
Add a new map source ~sunpy.map.sources.ADAPTMap for ADvanced Adaptive Prediction Technique (ADAPT) data files. (#7640)
-
Added support for JSOC's HMI millisecond TAI time format. Previously, it would only work with seconds. (#7656)
-
Added build support for aarch64 wheels. (#7679)
Bug Fixes
- Long object names are no longer truncated in the logging output of
~sunpy.coordinates.get_horizons_coord. ([sunpy#7319](https://githu...