LoadsFews

loads.LoadsFews()

Met deze functie worden gegevens uit de opgegeven FEWS omgeving opgehaald via REST.

Attributes

Name Description
data_adapter
df_in The type of the None singleton.
df_out The type of the None singleton.
input_schema dict() -> new empty dictionary

Methods

Name Description
create_dataframe Maak een pandas dataframe
create_params Maak een lijst van FEWS parameters om mee te sturen bij het ophalen van data.
create_url Maak een REST-URL voor FEWS
log_exceptions Stuurt exceptions eerst naar de logger van de DataAdapter
run De runner van de Loads FEWS.

create_dataframe

loads.LoadsFews.create_dataframe(
    options,
    calc_time,
    json_data,
    locations,
    global_variables,
)

Maak een pandas dataframe

Parameters

Name Type Description Default
options dict Opties uit de invoer yaml required
calc_time datetime T0 in UTC required
json_data str JSON data van FEWS required
locations pd.DataFrame Dataframe met meetlocaties required
global_variables dict Globale variabelen uit de invoer yaml required

Returns

Name Type Description
DataFrame pandas.core.Dataframe Met daar in: - Meetlocatie id (measurement_location_id) - Meetlocatie code (measurement_location_code) - Meetlocatie omschrijving/naam (measurement_location_description) - Parameter id overeenkomstig Aquo-standaard: ‘4724’ (parameter_id) - Parameter code overeenkomstig Aquo-standaard: ‘WATHTE’ (parameter_code) - Parameter omschrijving overeenkomstig Aquo-standaard: ‘Waterhoogte’ (parameter_description) - Eenheid (unit) - Datum en tijd (date_time) - Waarde (value) - Type waarde: meting of verwachting (value_type)

create_params

loads.LoadsFews.create_params(calc_time, options, moments, locations)

Maak een lijst van FEWS parameters om mee te sturen bij het ophalen van data.

Parameters

Name Type Description Default
calc_time datetime T0 in UTC required
options dict options uit de invoer yaml required
moments list Lijst van momenten in uren required
locations pd.DataFrame Dataframe met meetlocaties required

Returns

Name Type Description
lijst met parameters: dict De parameters die meegegeven moeten worden aan de FEWS API

create_url

loads.LoadsFews.create_url(options)

Maak een REST-URL voor FEWS

Parameters

Name Type Description Default
options dict Options uit de invoer yaml required

Returns

Name Type Description
URL str De URL voor de FEWS REST API

log_exceptions

loads.LoadsFews.log_exceptions(method)

Stuurt exceptions eerst naar de logger van de DataAdapter

run

loads.LoadsFews.run(input, output)

De runner van de Loads FEWS.

Parameters

Name Type Description Default
input str De naam van de input data met meetlocaties bekend in FEWS required
output str De naam van de output data met resultaten uit FEWS required

Returns

Name Type Description
None

Raises

Name Type Description
UserWarning Als de LoadsFews niet in de globale variabelen staat