ims-envista 0.1.14

Israel Meteorological Service Envista API wrapper package

IMS Envista

==========================

ims_envista is an unofficial IMS (Israel Meteorological Service) python API wrapper for Envista service.

Features supported

• Get latest meteorological readings from IMS Envista
• Get measurement data by region, station and date range.
• Get Daily and Monthly readings by measurement station.

Components and Frameworks used

• aiohttp
• async-timeout

Installing

pip3 install --upgrade ims-envista

Working with the API

Initialize the client with an IMS API token and use the async API methods to fetch station/region data.

Getting an IMS Token

You can read about the API and about how to get a token here - signing terms of use, etc.

import os
from ims_envista import IMSEnvista

# Create IMS client with token from environment
ims = IMSEnvista(os.environ["IMS_TOKEN"])

# Get JERUSALEM stations for getting an id
[station for station in await ims.get_all_stations_info() if station.name.startswith("JERUSALEM")]
> [JERUSALEM GIVAT RAM(22) - Location: [Lat - 31.771 / Long - 35.197], Active, Owner: ims, RegionId: 7, Monitors: [
    Rain(mm), WSmax(m / sec), WDmax(deg), WS(m / sec), WD(deg), STDwd(deg), TD(degC), RH( %), TDmax(degC), TDmin(
    degC), Grad(w / m2), DiffR(w / m2), WS1mm(m / sec), Ws10mm(m / sec), Time(hhmm), NIP(
    w / m2)], StationTarget:, JERUSALEM
CENTRE(23) - Location: [Lat - 31.781 / Long - 35.222], Active, Owner: ims, RegionId: 7, Monitors: [Rain(mm),
                                                                                                   WSmax(m / sec),
                                                                                                   WDmax(deg),
                                                                                                   WS(m / sec), WD(deg),
                                                                                                   STDwd(deg), TD(degC),
                                                                                                   TDmax(degC),
                                                                                                   TDmin(degC),
                                                                                                   WS1mm(m / sec),
                                                                                                   Ws10mm(m / sec),
                                                                                                   Time(hhmm), BP(mb),
                                                                                                   RH( %)], StationTarget:, JERUSALEM
CENTRE_1m(248) - Location: [Lat - 31.7806 / Long - 35.2217], Active, Owner: ims, RegionId: 7, Monitors: [Rain_1_min(mm),
                                                                                                         Rain_Corr(
                                                                                                             mm)], StationTarget:, JERUSALEM
GIVAT
RAM_1m(249) - Location: [Lat - 31.7704 / Long - 35.1973], Active, Owner: ims, RegionId: 7, Monitors: [Rain_1_min(mm),
                                                                                                      Rain_Corr(
                                                                                                          mm)], StationTarget:]

# Get latest data by a station id
await ims.get_latest_station_data(23)
> Station(23), Data: [Station: 23, Date: 2023 - 02 - 21
12: 00:00 + 02: 00, Readings: [(TD: 17.6°C), (TDmax: 17.8°C), (TDmin: 17.5°C), (RH: 58.0 %), (Rain: 0.0mm),
                               (WS: 2.8m / s), (WSmax: 3.7m / s), (WD: 285.0deg), (WDmax: 289.0deg), (STDwd: 10.5deg),
                               (WS1mm: 3.4m / s), (WS10mm: 2.9m / s)]]

Methods

Method	Description	Parameters	Returns
get_latest_station_data	Get Latest Station Readings	station_id: int, (optional) channel_id: int	StationMeteorologicalReadings
get_earliest_station_data	Get Earliest Station Readings	station_id: int, (optional) channel_id: int	StationMeteorologicalReadings
get_station_data_from_date	Get Station Reading from a specific date	station_id: int, date: datetime, (optional) channel_id: int	StationMeteorologicalReadings
get_station_data_by_date_range	Get Station Readings from a date range	station_id: int, from_date: datetime, to_date: datetime, (optional) channel_id: int	StationMeteorologicalReadings
get_daily_station_data	Get Daily Station Readings	station_id: int, (optional) channel_id: int	StationMeteorologicalReadings
get_monthly_station_data	Get Monthly Station Readings	station_id: int, (optional) channel_id: int, (optional) month: str, [e.g. 03] (optional) year: str [e.g. 2020]	StationMeteorologicalReadings
get_all_stations_info	Get station info for all stations		list[Station]
get_station_info	Get station info by station_id	station_id: int	Station
get_all_regions_info	Get region info for all regions		list[Region]
get_region_info	Get Region Info by region_id	station_id: int	Region
get_metrics_descriptions	Get station measurements description		listIMSVariable

Local Development

Clone from Github

Clone the repo from GitHub

git clone [e-mail]:GuyKh/ims-envista.git

Requirements

Package requirements are handled using pip. To install them do

pip install -r requirements.txt

Local Installation

To install locally:

python setup.py install

Tests

Testing is set up using pytest and coverage is handled with the pytest-cov plugin.

Run your tests with py.test in the root directory.

Coverage is ran by default and is set in the pytest.ini file. To see an html output of coverage open htmlcov/index.html after running the tests.