Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

Unreleased

Updated post-set-release in makefile to include missing major version bump
Fixed readme instructions regarding production deployment

11.3.0

Use coordinates of the ska-low telescope instead of the nearby ASKAP telescope.
Added cache clearing in Astropy if ‘ska-low’ is missing from site names.
Changed readme instructions for accessing the Swagger UI

11.2.2

Fixed Mid PSS sampling time from 12.4e-6 * u.second to 65e-6 * u.second.

11.2.0

Add SKA-Low inner and outer subarray templates from the subarray templates memo v2.
Updated the transformed results for MID to Jy / beam

11.1.2

Note: Re-release as it appears 11.1.1 had some issues
Added sensitivity limit warning for transformed results of /low/zoom/calculate
Changed sensitivity limit warnings format in Low to be consistent with the ones in Mid
Changed the PSS responses to reflect updates to PSS modes
Fixed the OpenAPI response examples to reflect changes in calculate endpoints

11.1.1

Added sensitivity limit warning for transformed results of /low/zoom/calculate
Changed sensitivity limit warnings format in Low to be consistent with the ones in Mid
Changed the PSS responses to reflect updates to PSS modes
Fixed the OpenAPI response examples to reflect changes in calculate endpoints

11.1.0

Removed “LOW_AA2 (core only)” subarray since it no longer exists
Added new look-up tables for Low AA0.5, AA1, and AA2 subarrays
Changed the location of scripts for look-up table generation to a separate folder
Added a Dockerfile to install all the relevant dependencies needed to generate look-up tables
Removed null values in transformed section of response for Mid Zoom

11.0.0

[BREAKING] Changed /mid/continuum/calculate endpoint:
- Combine weighting and calculate params and return sensitivities or integration times, continuum and spectral weighting results, and transformed results (for ui display)
- Business logic is moved from ska-ost-senscalc-ui
- Added subbands transformed results in transformed section of response
- Added Generation of subband_freq_centres_hz if not provided when n_subbands > 1
- Changed some of the validation logic to handle subband_freq_centres_hz and n_subbands inputs
- Added sensitivity_unit for supplied_sensitivity
[BREAKING] Removed /mid/continuum/weighting endpoint
[BREAKING] Changed /mid/zoom/calculate endpoint:
- Combine weighting and calculate params and return original calculate, spectral weighting results, and transformed results (for ui display)
- Business logic is moved from ska-ost-senscalc-ui
- Added sensitivity_unit for supplied_sensitivities
[BREAKING] Removed /mid/zoom/weighting endpoint
[BREAKING] Changed /low/continuum/calculate endpoint:
- Combine weighting and calculate params and return sensitivities, continuum and spectral weighting results, and transformed results (for ui display)
- Business logic is moved from ska-ost-senscalc-ui
- Added subbands transformed results in transformed section of response
- Added Generation of subband_freq_centres_mhz if not provided when n_subbands > 1
- Changed some of the validation logic to handle subband_freq_centres_mhz and n_subbands inputs
[BREAKING] Removed /low/continuum/weighting endpoint
[BREAKING] Changed /low/zoom/calculate endpoint:
- Combine weighting and calculate params and return sensitivities or integration times, spectral weighting results, and transformed results (for ui display)
- Business logic is moved from ska-ost-senscalc-ui
[BREAKING] Removed /low/zoom/weighting endpoint
Added Mid PSS (Single and Folded) endpoint
Added Single Pulse functionality to Low PSS endpoint
Changed calculate warning to warnings and to be an array of string instead of a string
Changed location of classes in low and common services into model.py
Changed error handling in Mid calculate validation by accumulating errors, similarly to Low validation

10.2.0

Removed dependency on PyEphem
Update the lookup tables to add the following new subarray configurations to the MID calculator:
- Mid_inner_r125m_AA*
- Mid_inner_r500m_AA*
- Mid_inner_r2km_AA*
- Mid_inner_r20km_AA*
- Mid_inner_r125m_AA4
- Mid_inner_r500m_AA4
- Mid_inner_r2km_AA4
- Mid_inner_r20km_AA4
- MID Calculator is refactored to remove Calculator class and instead use a number of functions

10.1.0

Low sensitivity calculator speed improvement: Update SEFDTable class to be HDF5-backed instead of sqlite-backed
- Smaller database: 894.7 MB -> 36.8 MB
- Faster runtime
- Bug fix for multiple LST steps

10.0.0

Major breaking changes to the calculate and weighting APIs to make them consistent and easier to use.

[BREAKING] /mid/calculate endpoint is now split into /mid/zoom/calculate and /mid/continuum/calculate
- Response body of /mid/continuum/calculate returns a single object with the continuum and spectral sensitivities/integration times, plus subband results if applicable
- Response body of /mid/zoom/calculate returns an array of continuum and spectral sensitivities/integration times for each zoom window
[BREAKING] /low/zoom/calculate now also returns an array of results (and likewise accepts an array of freq_centres_mhz)
[BREAKING] The calculator mode (continuum, zoom, pss) and the spectral mode (continuum or line/spectral) are now distinguished in the API.
[BREAKING] /mid/weighting endpoint is now split into /mid/continuum/weighting and /mid/zoom/weighting. Similar to calculate, an array is returned for zoom.
[BREAKING] /low/{spectral_mode}/weighting has been split into explicitly separate /low/zoom/weighting and /low/continuum/weighting with separate params (eg only subbands for continuum)
[BREAKING] Several parameters renamed to make consistent
- Parameters have units appended, egsensitivity -> sensitivity_jy
- Parameters that are arrays are plural, eg subband_sensitivities_jy
- Variations of frequency changed to freq_centre_<unit>
- Low duration changed to integration_time_h
- el changed to elevation_limit
[BREAKING] Response bodies updated to use same field names, at the top level of the object (ie no more data and status fields for mid).
[BREAKING] Response quantities now are an object with value and unit, rather than a number with an implicit unit.