o3api 0.8.5

o3api is a part of the O3as service, which provides a service to efficiently explore ozone projections, including the calculation of key metrics.

o3api documentation is available in https://o3as.readthedocs.io/en/latest/o3api/docs/source/

Changes since 0.8.0

Added

• Code of conduct, Contributing, codemeta

Changed

• model's plotstyle is now loaded from the file provided in the "O3AS_DATA_SOURCES_CSV" environment variable (defaults to "O3AS_DATA_BASEPATH/Data sources - Sources.csv")
• change the logic how boxcar smoothing is applied:
  1. select data slice with valid data, i.e. avoid NaNs at start and end
  2. if there are NaNs within the data range, interpolate
  3. apply boxcar smoothing on this data slice
  4. update original data with the smoothed values
• the observed data is NOT shifted anymore to the reference point, i.e. measured data is taken 'as-it-is'
• Updated CI/CD to build docker images automatically
• Deployment in Kubernetes (k8s subdirectory) is now moved to the dedicated repository, o3k8s
• Updated the documentation
• Update requirements

Fixed

• JSON output lists all years for the selected range, even if there is no data. Otherwise some regions may be missed in the tco3_return plot

o3api 0.8.0

o3api is a part of the O3as service, which provides a service to efficiently explore ozone projections, including the calculation of key metrics.

o3api documentation is available in https://o3as.readthedocs.io/en/latest/o3api/docs/source/

Changes since 0.7.0

Added

• Optional linear interpolation of missing data in the case of a reference measument

Changed

• Code refactoring and optimisation
• Data loading: data is loaded in-memory when the application starts, instead of reading files via xarray.open_mfdataset()
• Updated documentation
• Updated requirements

Fixed

• Fixed calculation of the median (bug: "mean" was included in the calculation)

o3api 0.7.0

o3api is a part of the O3as service, which provides a service to efficiently explore ozone projections, including the calculation of key metrics.

o3api documentation is available in https://o3as.readthedocs.io/en/latest/o3api/docs/source/

Changes since 0.6.0

Added

• Legal info URL in the JSON document returned by API
• Removal of E-Mails from the model metadata
• Kubernetes deployment includes ingress and cluster_issuer to get letsencrypt certificate

Changed

• Updated to OpenAPI v3
• PDF plotting now returns 2-page document:
  • first page contains the plot itself
  • second page containes links to the legal info, acknowledgment, and the list of input parameters

Fixed

• Updated requirements to match package versions

o3api 0.6.0

This is the first live release of the REST API for the O3as service, o3api

O3as provides a service to efficiently explore ozone projections, including the calculation of key metrics.

Main features

• REST API is based on the OpenAPI 2.0

• The API endpoints provide the following functionalities:

  • creation of TCO3 plots (JSON or PDF)
  • creation of TCO3_Return plots (JSON or PDF)
  • retrieving list of available climate models
  • retrieving of the pre-defined plotstyle for every model
  • retrieving of the model's metadata
  • retrieving of the skimmed data used for plotting

• o3api is dockerised

• Documentation is available in https://o3as.readthedocs.io/en/latest/o3api/docs/source/