Print acknowledgment statements

[0.23.1] - 2024-06-15

Added

• The asilib.acknowledge.acknowledge() function. It should be called by each loader to print that ASI's acknowledgment statement either when 1) the first time the user calls the function, or 2) when it has been a month since it was last called.
• Tests for asilib.acknowledge.acknowledge().
• Added the call to asilib.acknowledge.acknowledge() in asilib.asi.rego(), asilib.asi.trex_rgb(), and asilib.asi.trex_nir().

Animate mosaics

[0.23.0] - 2024-04-21

Added

• Imagers.animate_map() and Imagers.animate_map_gen() methods to animate mosaics.
• Imagers.__iter__() to iterate over every imager synchronously. This won't work perfectly when you mix multiple imager arrays such as REGO and THEMIS, as their cadences are 6- and 3-seconds, respectively.
• Imagers.__str__() to print details regarding each ASI imager.
• Tests for the above methods.
• A warning in the Calgary downloader function if there was no image data locally or online.
• A mosaic animation example in the documentation.

Fixed

• A bug when no data from an hour exists and asilib.Downloader() crashed when it did not find the folder.

Changed

• Incremented the dependencies in requirements.txt.

Full Changelog: v0.22.0...v0.23.0

aurora-asi-lib -> asilib

[0.22.0] - 2024-03-11

Changed

• Renamed aurora-asi-lib to asilib in PyPI. Now the package can be installed via python3 -m pip install asilib.

Support python 3.12

[0.21.1] - 2024-03-02

Changed

• Removed support for python 3.8
• Added support for python 3.12
• Incremented two package versions in requirements.txt: scipy==1.20.0 and h5py==3.10.0.

Added

• Project metadata in pyproject.toml and removed setup.cfg.
• Additional package URLs in PyPI.

Added the animation_save_dir

Added

• An animation_save_dir kwarg to Imager.animate_fisheye_gen() and Imager.animate_map_gen().

Fixed conjunction bug

[0.20.7] - 2024-02-19

Fixed

• Auroral intensities resulted in an index error is the satellite was at the horizon.

Removed the RGB color normalization in the loader

[0.20.6] - 2024-02-18

Changed

• Removed the RGB normalization in the trex_rgb() loader. This fixed the vertical stripes in the keograms, but made the fisheye and mapped images much darker (since the norm kwarg in plt.pcolormesh and plt.imshow does nothing).
• Refactored the TREx and Imager tests reflecting the minor changes.

Added

• A color_brighten kwarg to by default enhance the RGB colors when calling the following asilib.Imager methods, plot_fisheye, animate_fisheye_gen, plot_map, and animate_map_gen. Unless color_brighten=False, the plots remain the same.

Fixed Imagers bug with a single Imager object

[0.20.5] - 2023-12-20

Fixed

• A bug raised in issue #15 where an asilib.Imagers class, initiated with a single asilib.Imager, would try to incorrectly index asilib.Imager unless it is wrapper in a tuple.

Average multiple images in psa_emccd()

[0.20.4] - 2023-11-17

Added

• The n_avg and imager kawrgs to the psa_emccd() function. These kwargs allow for custom Imager instance, as well as average the images over n_avg times.

Custom mapping altitudes and color channels.

[0.20.3] - 2023-10-10

Added

• custom_alt kwarg to the THEMIS, REGO, and TREx loaders. Credit: Cassandra M.
• A test for the custom_alt functionality.
• Tests for the custom colors.

Changed

• How RGB color channels are loaded. By picking one or multiple color channels, the underlying data for the unselected channels is masked as NaNs. matplotlib handles these images well.