regobslib 1.0.11

Client library for Regobs

regobslib — A Regobs client library

This client library aim to simplify interaction with the Regobs API v5.

Prerequisites

• A client ID for the test or prod environment, contact [e-mail] to acquire this.
• A user account for the test or prod environment. Register here:
  • Test environment: https://test-konto.nve.no/
  • Prod environment: https://konto.nve.no/
• Basic knowledge about snow science nomenclature. For more info, see the following resources:
  • NVE Field Book
  • Observation Guidelines and Recording Standards for Weather, Snowpack and Avalanches
  • Snow, Weather and Avalanches

Installation

To install using pip:

pip install regobslib

Example programs

Searching for data

Here is an example program searching for weather observations in Ofoten.

from regobslib import *

connection = Connection(prod=True)
results = connection.search(SnowRegistration, regions=[SnowRegion.OFOTEN], observation_types=[Weather])

print(f"Length of results: {len(results)}\n")

print("First result")
print(results[0])

print("\nIterates over results")
for result in results:
    print(f"Id: {result.id}, Observer: {result.observer.nickname}, Date: {result.obs_time}")

Submitting data

Below is a simple program demonstrating how to register a whumpf sound at a given location and time.

from regobslib import *
import datetime as dt

# Contact [e-mail] to get a client ID.
CLIENT_ID = "00000000-0000-0000-0000-000000000000"

# Create a user at https://test-konto.nve.no/ or https://konto.nve.no/
USERNAME = "[e-mail]"
PASSWORD = "P4ssw0rd"

# First we create an empty SnowRegistration object
reg = SnowRegistration(REGOBS_TZ.localize(dt.datetime(2021, 8, 17, 9, 48)),
                       Position(lat=68.4293, lon=18.2572))

# Then we add a DangerSign observation to it
reg.add_danger_sign(DangerSign(DangerSign.Sign.WHUMPF_SOUND))

# Authenticate to Regobs to be able to submit observations
connection = Connection(prod=False).authenticate(USERNAME, PASSWORD, CLIENT_ID)

# Send our SnowRegistration to Regobs
stored_reg = connection.submit(reg)
print(stored_reg)

For a more extensive demonstration, refer to demo.py.

Documentation

We have yet to write documentation, but the function declarations are written with type hints and most parameters are enums, so the code in submit.py may help you on your way. A properly set up IDE will also use the type hints and enums to inform you about your alternatives.

You can also use GitHubs built-in code navigation to quickly find the definition of a class or method in the example code.

Developer notes

The package is built according to the instructions in the Python Packaging User Guide.

For serialization/deserialisation, most of the Regobs work is done in src/regobslib/submit.py. The project rely heavily on enums. These are available in src/regobslib/types.py. Any outside connections (Regobs, Varsom, APS) is handled in src/regobslib/connection.py.