WeatherForecast Developer Guide¶

The WeatherForecast CSC downloads forecast information from the Meteoblue forecast service API. It will publish an updated forecast model every 12 hours or twice a day. The service uses URL parameters to configure the call to the API

latitude - the latitude of the forecast model
longitude - the longitude of the forecast model
apikey - the API key that authenticates with the service

The API returns a JSON formated file which is then objectfied into a dictionary of dictionaries of arrays. Each field is then published as telemetry to the WeatherForecast DDS telemetry.

Dependencies¶

SAL - v7.0.1
ts_salobj - v7.2.0

WeatherForecast API¶

The content in this section is autogenerated from docstrings.

lsst.ts.weatherforecast Package¶

Functions¶

execute_csc()

Execute the CSC.

Classes¶

WeatherForecastCSC([initial_state, ...])

Implement the WeatherForecast CSC.

Build and Test¶

Assuming use of the develop-env docker container.

setup -kr .
scons --clean
scons

pip install -e .
pytest -ra .

Usage¶

In order to run the CSC, the METEOBLUE_API_KEY environment variable needs to be set.

Simulator¶

No simulator is written nor provided. There is a forecast-test.json file that serves as data for the unit tests.

Updating Firmware of the WeatherForecast¶

There is no firmware associated with this software but is technically beholden to the Meteoblue API format.

Building the Documentation¶

Assuming use of the develop-env container and package installed already.

package-docs build

Contributing¶

Code and documentation contributions utilize pull-requests on github. Feature requests can be made by filing a Jira ticket with the ts_weatherforecast label. In all cases, reaching out to the contacts for this CSC is recommended.

Navigation