LoadsMatroos

loads.LoadsMatroos()

Haalt matroos tijdserie informatie op uit de Noos, Matroos of Vitaal server.

De Matroos informatie is beschikbaar op de volgende websites: https://noos.matroos.rws.nl/maps1d/

Met de functie get_matroos_sources() kan je de beschikbare bronnen ophalen. Met de functie get_matroos_locations(source='...') kan je de bijbehorende beschikbare locaties ophalen.

Attributes

Name	Type	Description
data_adapter	DataAdapter	Data adapter object for input and output data.
df_in	Optional[pd.DataFrame] | None	Input dataframe containing measurement location codes.
df_out	Optional[pd.DataFrame] | None	Output dataframe containing processed data.
url_retrieve_series_noos	str	URL for retrieving series from Noos server.
url_retrieve_series_matroos	str	URL for retrieving series from Matroos server.
url_retrieve_series_vitaal	str	URL for retrieving series from Vitaal server.

Methods

Name	Description
create_dataframe	Maakt een dataframe met waardes van de rws water webservices
format_location_names	Neemt een lijst met locatienamen en verwijdert spaties en maakt ze allemaal in kleine letters
generate_url	Geeft de benodigde URL terug om het verzoek naar de Noos-server te maken
get_matroos_available_locations
log_exceptions	Stuurt exceptions eerst naar de logger van de DataAdapter
run	Voert de functie uit om gegevens op te halen en te verwerken voor matroos gegevens.

create_dataframe

loads.LoadsMatroos.create_dataframe(
    options,
    df_in,
    calc_time,
    json_data,
    global_variables,
)

Maakt een dataframe met waardes van de rws water webservices

Parameters

Name	Type	Description	Default
options	dict	Een dictionary met opties uit de config	required
df_in	pd.DataFrame	Het invoerdataframe	required
calc_time	datetime	De huidige tijd	required
json_data	list	Een lijst met ogehaalde JSON data	required
global_variables	dict	Een dictionary met globale variabelen	required

Returns

Name	Type	Description
dataframe	pd.Dataframe	Pandas dataframe met de voor uitvoer

format_location_names

loads.LoadsMatroos.format_location_names(location_names)

Neemt een lijst met locatienamen en verwijdert spaties en maakt ze allemaal in kleine letters

generate_url

loads.LoadsMatroos.generate_url(options, global_variables)

Geeft de benodigde URL terug om het verzoek naar de Noos-server te maken

Parameters

Name	Type	Description	Default
options	dict	Opties die door de gebruiker zijn opgegeven, in dit geval is ‘source’ het belangrijkst	required
global_variables	dict	Globale variabelen die nodig zijn om de URL te genereren	required

Returns

Name	Type	Description
url	str	De gegenereerde URL voor het verzoek aan de Noos-server

Raises

Name	Type	Description
	UserWarning	Als de ‘website’ niet is opgegeven in de opties Als de ‘website’ niet overeenkomt met de opties ‘noos’, ‘matroos’ of ‘vitaal’ Als de ‘website’ ‘matroos’ of ‘vitaal’ is en de gebruiker geen gebruikersnaam en wachtwoord heeft opgegeven

get_matroos_available_locations

loads.LoadsMatroos.get_matroos_available_locations(
    df_in,
    options,
    endpoint_model,
)

log_exceptions

loads.LoadsMatroos.log_exceptions(method)

Stuurt exceptions eerst naar de logger van de DataAdapter

run

loads.LoadsMatroos.run(input, output)

Voert de functie uit om gegevens op te halen en te verwerken voor matroos gegevens.

Parameters

Name	Type	Description	Default
input	str	Naam van de dataadapter met invoergegevens.	required
output	str	Naam van de dataadapter om uitvoergegevens op te slaan.	required

Raises

Name	Type	Description
	UserWarning	Als de ‘LoadsMatroos’ sectie niet aanwezig is in de global_variables (config). Als de ‘measurement_location_code’ ontbreekt in de inputdata. Als het gegeven model niet wordt herkend. Als de locaties niet worden gevonden.
	ConnectionError	Als er geen resultaten in de data zitten. Als de verbinding mislukt.