Full Changelog#

0.3.0 (2026-06-05)#

Breaking Changes#

  • The ScienceData method get_data() is now keyword only. (#196)

  • Increased minimum versions for these dependencies:

    • Python >= 3.12

    • astropy >= 6.1.0

    • matplotlib >= 3.8.0

    • sunpy >= 7.0

    • xrayvisim >= 0.2.1 (#212)

Removals#

New Features#

  • Add ability to control the data normalisation to get_data via the vtype keyword:

    • ‘c’ - count [c]

    • ‘cr’ - count rate [c/s]

    • ‘dcr’ - differential count rate [c/(s keV)] (#196)

Bug Fixes#

  • Fixed version attributes not being exported in stixpy.net.attrs module. All version attributes (Version, VersionU, MinVersion, MinVersionU, MaxVersion, MaxVersionU) are now properly included in the module’s __all__ list and can be imported directly from stixpy.net.attrs. (#209)

  • Fix Imaging Demo to correctly use center of STIX field of view for initial grid correction and flare position estimation. (#216)

Internal Changes#

  • Update STIXClient Fido client to use format keyword and parse syntax, internal changes only. (#177)

  • Update package with sunpy template and enable updates. (#219)

Stixpy 0.2.1 (2026-03-10)#

Bug Fixes#

  • Update sunpy dependency to <7.0 as code not updated for new Fido client API. (#211)

Stixpy 0.2.0 (2026-01-18)#

Backwards Incompatible Changes#

  • Update minimum dependencies of Python 3.11 and sunpy to 6.0.0 inline with SPEC 0. (#174)

Features#

  • Update Fido client to optionally take root path or url. Also add attributes to enable searching for specific versions for example latest version available. (#143)

  • Enable stixpy.calibration.visibility.create_meta_pixels to include only top or bottom row of big pixels. (#148)

  • Update Fido client for change in aspect/ephemeris file name and path. (#153)

  • Add the pixel area normalisation from create_meta_pixels to dictionary returned. (#162)

  • Add new timeseries source for STIX ANC aspect data ANCAspect. (#169)

  • Add a instrument configuration constant STIX_INSTRUMENT to bundle instrument constants like grid configurations, pixel sizes …. (#171)

  • Update imaging demo to use Sun center as location for making initial full disk back projection to determine flare location. (#173)

  • Add enhanced pixel plot ~`stixpy.product.sources.science.PixelPlotMixin` improved layout now shows detector quadrant and labels. Pixel plots now support three options a normal bar plot an error bar plot and configuration plot. (#178)

  • Created new stixpy.visualisation.plotters.PixelPlotter class to create pixel plots by moving and refactored code from current mixin so current API is maintained. This new approach simplifies the science module and programmatic access to the plot controls enabling animations. (#181)

Bug Fixes#

  • Fixed a bug in stixpy.calibration.visibility.create_meta_pixels to correctly determine which time bins to include in the sum based on their overlap with the specified time range. (#138)

  • Fix bug in orientation of grids for internal shadowing. (#146)

  • Fix bug where pointing information could be improperly interpolated in get_hpc_info. (#152)

  • Fix typo in create_meta_pixels which cased error if grid shadow correction was enabled. Also update grid calculations to use Skycoord objects. (#156)

  • Fix error in filter_for_latest_version if the result table was empty. (#160)

  • Fix bug in STIX Fido client which caused data that spanned midnight to be missed. (#176)

  • Fix apparent bug in create_meta_pixels by improving naming and docstrings. (#194)

  • Fix incomplete conversion of calibrate_visibility to use SkyCoord. (#194)

  • Fix ELUT reader read_elut for column name change in upstream files. (#194)

  • Restore mistakenly dropped updateds to the energies used in generate_transmission_tables.: (#197)

  • Fix bug in get_data when specifying pixel_indices with data containing less than 12 pixels. (#200)

Improved Documentation#

  • Convert reconstructions to proper sunpy maps in ref`:ref:sphx_glr_generated_gallery_imaging_demo.py. (#141)

  • Added instructions for initializing and updating git submodules and fixed broken links. (#157)

Trivial/Internal Changes#

  • Update project configuration move to project.toml and individual config files for each tool (isort, ruff, pytest, etc) and add zenodo config file and mailmap. (#158)

Stixpy 0.1.2 (2024-07-16)#

Features#

  • Add a custom coordinate frame stixpy.coordinate.frames.STIXImaging and the associated transformations (stixim_to_hpc, hpc_to_stixim) to and from Helioprojective. Also add a stixpy.map.stix.STIXMap for Map source which properly displays the stixpy.coordinate.frames.STIXImaging coordinate frame. (#90)

  • Merged stixpy.calibration.get_visibility_info_giordano and stixpy.calibration.get_visibility_info into stixpy.calibration.get_uv_points_data and removed stixpy.calibration.correct_phase_projection. (#98)

  • Update livetime correction parameter eta, tau and add code to calculate pileup ‘beta’ stixpy.calibration.livetime.pileup_correction_factor(). (#100)

  • Add background subtraction step to imaging demo, update EnergyEdgeMasks. (#106)

  • Update imaging demo to use images and construct Map using STIXImaging and make_fitswcs_header. (#107)

  • Update get_hpc_info() to use mean or interpolate pointing and location data based on number of data points in given timerange. Add function cache for aux data frequenly needed during coordinate transforms. (#111)

  • Make the imaging demo compatible with Visibilities (#123)

  • Update code and examples to use new Visibilities, tidy API of em. (#124)

  • Add missing QL products QLVariance, QLFlareFlag, and QLTMStatusFlareList to Product. Also added some useful properties to the for status words. (#125)

Bug Fixes#

  • Fix ELUT correction when the requested data has less then than 32 energy channels. (#106)

  • Update get_elut to use correct science energy channels for given date. (#107)

  • Fix a bug where the incorrect unit was set on QLLightCurve, QLBackground and QLVariance. (#118)

  • Fix bug where coordinate transforms did not support arrays of coordinates or times. To so support both integrated (e.g. images) and instantaneous (e.g. coarse flare flag) a new property obstime_end was added to STIXImaging when set if possible mean pointing and position information are use for transformations other wise they are interpolated between the two nearest data points. (#128)

  • Fix typo in ScienceData ‘durtaion’ -> ‘duration’. (#132)

  • Fix some inconsistencies on the data units in plots, also return handle to the image from plot_spectrogram. (#134)

Improved Documentation#

  • Update README, fix graphviz RTD configuration, configure theme logo text. (#89)

  • Correct calculation of the HPC coordinate of the center of the STIX pointing in the imaging demo. (#112)

  • Update imaging demo for latest changes in xrayvision. (#115)

Trivial/Internal Changes#

  • Format code with ruff and turn on ruff format in pre-commit. (#116)

Stixpy 0.1.3 (2024-07-16)#

Bug Fixes#

  • Fix some inconsistencies on the data units in plots, also return handle to the image from plot_spectrogram. (#134)

  • Fix bug reintroduce by last fix in em, update code in calibrate_visibility and imaging demo to use Tx, Ty rather than Ty, Tx as before. (#137)