Skip to content

Releases: Helioviewer-Project/api

4.4.3

01 Oct 17:55
c451f40
Compare
Choose a tag to compare

Summary

This is a small bug fix patch. 3 issues have been fixed:

  • Fixed an intermittent error with creating screenshots and movies. This would appear as an error saying the screenshot/movie cannot be created.
  • Fixed an error that prevented downloading/playing large movies
  • Fixed an issue where attempting to share the viewport fails intermittently when using the "base difference" option

One minor update has been made to the popup which shows the FITS Metadata:

  • The sort button previously said "Abc", now says "Sort Labels" to be more clear.

Upgrade Guide

Only composer install is needed after updating to this version.

What's Changed

Full Changelog: 4.4.2...4.4.3

4.4.2

10 Sep 18:19
2b4837d
Compare
Choose a tag to compare

Summary

This patch is mostly bug fixes with the notable exception of enabling support for Sentry, a tool for application error monitoring.

Overview of changes:

  • updates some schema rules that block certain save state requests.
  • Report application errors to sentry

Upgrade from 4.4.1

2 upgrade steps are needed.

  1. Before getting 4.4.2, update your Config.ini with these lines:
[application]
app_env     = production

[sentry]
sentry_dsn = http://sentry-dsn
sentry_enabled = false
sentry_sample_rate = 0.1
  1. After getting 4.4.2, run composer install
  2. Restart the resque based movie workers with your preferred method. I do pkill -f resque and then re-run movie_queues.tcsh

What's Changed

Full Changelog: 4.4.1...4.4.2

4.4.1

18 Jul 19:49
Compare
Choose a tag to compare

Version 4.4.1 resolves some bugs identified in the base 4.4.0 release.

  • Fixes an issue where downloading a screenshot from the screenshot preview results in an illegible file name.
  • Fixes issue where attempting to share the viewport after selecting an image layer preset fails
  • Fixes an issue where attempting to share the viewport fails with difference images
  • Fixes slow loading for getObservationDate videos (resolves loading problems with embedded version of Helioviewer)
  • Times out CCMC Event Loading at 10 seconds. Events that were received within the 10 second limit are cached and displayed.

What's Changed

Full Changelog: 4.4.0...4.4.1

4.4.0

15 Jul 15:31
f7de9ba
Compare
Choose a tag to compare

Highlights

It's been a while since I tagged the release, here's a list of the most important changes to note:

  • Added support for NSO GONG H-alpha
  • Added support for RHESSI reconstructions
  • Added the RHESSI Flare List as a new Features & Event source. RHESSI operated between February 2002 to August 2018.
  • Improved mouse/cursor coordinate support
  • Added getEclipseImage endpoint for https://eclipse.helioviewer.org
  • Enabled exporting Helioviewer.org videos to JHelioviewer
  • Enabled continuous zoom for desktop devices with option to revert to step zoom in user settings.

Upgrade Guide

If you're running a Helioviewer instance, perform the following steps to upgrade from 4.3.0 to 4.4.0.

Pre-Requisites:

  • Install Docker or Podman to run a supporting container
  1. Update Configuration files
  2. Update source code to 4.4.0
  3. run composer install to update dependencies
  4. Apply database updates
  5. Run coordinator container as a background process

Configuration Files

Add this line to Config.ini

coordinator_url = 'http://localhost:9000'

Database Updates

SQL File Description Notes
install/database/2024_05_31_add_events_state_to_both_screenshots_and_movies_tables.sql Enables storing event states for use with screenshots, movies, and sharing Required to work with 4.4.0
install/database/2024_05_16_create_client_states_table.sql Enables storing client state in db Required to work with 4.4.0
install/database/2023_06_23_gong_halpha.sql Enable's GONG H-alpha data source Only needed if you plan to host GONG H-alpha data
install/database/2024_04_03_rhessi.sql Enable's RHESSI data source Only needed if you plan to host RHESSI data

Process Updates (Coordinator)

  • Enable the Python-based Coordinate Transformer. This is a python-based http server which responds to requests to transform earth-based coordinates to coordinates as seen from Helioviewer's viewpoint (Always 1 AU), which improves event pin accuracy.
  1. Use docker to run the process docker run -d -p 9000:80 -t dgarciabriseno/hv-coordinator:0.1.0
  2. Make sure your Config.ini contains coordinator_url = 'http://localhost:9000'
  3. If your server is configured to send requests through a proxy, make sure your requests to localhost don't go through that proxy.

What's Changed

New Contributors

Full Changelog: 4.3.0...4.4.0

4.3.0

06 Jun 18:05
ccb50e7
Compare
Choose a tag to compare

Big Changes

  • Includes IRIS Data.
    • Special Note: Downloading IRIS from LMSAL requires a whitelisted IP. Use the hv_iris data server to download IRIS data from Helioviever.
  • Integrates the Helioviewer Event Interface for getting CCMC data

What's Changed

  • Remove ASSA flare predictions since their coordinates are incorrect.
  • Implement external Event interface for getting events
  • Fix issue where screenshots with event pins are missing a pin.
  • SUVI now appears on the API Status page.
  • Link Shortener now uses an internal implementation

New Contributors

Maintainer Notes:

  • The import_predictions.py table is no longer used. Nor is the flare table.
  • Execute 2023_05_11_update_suvi_instrument.sql to update SUVI in the database so it appears on the API Status Page
  • Execute 2023_05_16_iris_source.sql to add IRIS to the database
  • This project now uses composer to manage dependencies. Download and run composer install. This is required for Helioviewer to continue operating.
  • Use -d iris or -d hv_iris with downloader.py to get iris images

Full Changelog: 4.2.0...4.3.0

4.2.0

11 Apr 16:40
c1c985e
Compare
Choose a tag to compare

Improves storage of flare predictions based on 4.1.0 feedback.
The flare database introduced here is incompatible with 4.1.0 and updating drops the 4.1.0 flare table.

Release Notes:

  • Fixes the typo showing "Solar Flare Predictionss"
  • Removes a patch meant to try to "fix" ASSA latitude/longitude positions
  • Showing flare prediction source data now includes all data provided by the CCMC API

Maintainer Upgrade Guide:

  • After updating the API and App to 4.2.0, you must create the flare prediction database table by executing the SQL in /install/database/2023_04_11_update_flare_table.sql.
    • You do not need to run the 4.1.0 update first
    • If the 4.1.0 table exists, all data will be erased and will need to be re-imported.
  • Use /management/events/ccmc/import_predictions.py to retrieve flare predictions for your server. Use -h to see the script's usage information
  • Ideally you will run import_predictions.py on a schedule to keep flare predictions up-to-date
  • The GSFC servers run the following scheduled command
    import_predictions.py "$(date --date '3 hours ago' -u '+%FT%T')" "$(date --date '+48 hours' -u '+%FT%T')"

4.1.0

10 Apr 16:14
923c7b8
Compare
Choose a tag to compare

Helioviewer 4.1.0 adds feature support for the CCMC Flare Scoreboard.
The flare scoreboard is a database of predictions made by humans and algorithms for prediction when and where a solar flare may occur.
These predictions are now pinned on Helioviewer the same way that actual flares and other solar events are displayed.

Release Notes:

  • Stability improvements for creating movies and screenshots
  • Patches to data coverage statistics to fix overcounting files
  • Update to api status page to show full time range of available data with links to upstream data sources and internal coverage tables.
  • Several changes to remove usage of deprecated PHP features.
  • Support for CCMC Flare Scoreboard

Maintainer Upgrade Guide:

  • After updating the API and App to 4.1.0, you must create the flare prediction database table by executing the SQL in /install/database/2023_03_27_add_flare_table.sql
  • Use /management/events/ccmc/import_predictions.py to retrieve flare predictions for your server. Use -h to see the script's usage information
  • Ideally you will run import_predictions.py on a schedule to keep flare predictions up-to-date
  • The GSFC servers run the following scheduled command
    import_predictions.py "$(date --date '3 hours ago' -u '+%FT%T')" "$(date --date '+48 hours' -u '+%FT%T')"

4.0.0

03 Jan 21:49
421731d
Compare
Choose a tag to compare

We welcome 2023 with the official 4.0 release of Helioviewer which includes mobile support to the site.

  • commands to import events and update data coverage graphs have now have php scripts that can be run outside of the (undocmented) API requests that perform the same tasks
  • Fixed some typos in Documentation
  • Movies can no longer be reQueued with reQueueMovie while they're being processed.
  • Added downloadImage API which allows downloading full sun images as regular jpg images (not jpg2000). For Helios support
  • Fixed issues with some images not loading at zoomed out scales.
  • Fixed issues with the getTile API around invalid baseDiffTime and difference parameters
  • Fixed issues generating jpx files which caused failures to load data in JHelioviewer
  • Fixed getMovieStatus from returning null progress just before movies are completed.
  • Updated a SQL query for XRT to increase load speed for any/any filter wheel combination.

3.4.0

14 Jul 17:43
5b3374d
Compare
Choose a tag to compare

Changes:

  • Adds Solar Orbiter's EUI images.
  • Patched downloader to quit on certain download errors to prevent unintentionally adding nonexistent images to the database.
  • Updates how downloader.py scans for dates in filenames to support EUI
  • Creates the Helioviewer Availability Service feed. Leverages RSS to report when data acquisition falls behind schedule. see here
  • Fixes problem with generating movies over long time spans

3.3.5

29 Apr 17:27
d598957
Compare
Choose a tag to compare

Changes:

  • Update API Docs to use Read The Docs Theme and migrate from XML to reStructuredText
  • Update data download scripts to work with sunpy version 3
  • Add Helioviewer Availability Service for an RSS Feed on uptime status
  • Fixed issue with sharing private youtube videos
  • Minor backend patches (to fix PHP errors and warnings)