Merge pull request #103 from Ingenjorsarbete-For-Klimatet/feature/0.2.0

Feature/0.2.0

.github/workflows/github-action-docs.yaml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9"]
+        python-version: ["3.11"]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/github-action-lint.yaml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9"]
+        python-version: ["3.11"]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/github-action-md-lint.yaml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9"]
+        python-version: ["3.11"]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/github-action-type.yaml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9"]
+        python-version: ["3.11"]
 
     steps:
       - uses: actions/checkout@v2
@@ -19,9 +19,4 @@ jobs:
           pip install -e ".[type]"
       - name: Type checking with mypy
         run: >
-          MYPYPATH=src
-          mypy
-          --namespace-packages
-          --explicit-package-bases
-          --allow-redefinition
-          src
+          mypy src --ignore-missing-imports --exclude=src/smhi/smhi.py

.pre-commit-config.yaml

@@ -1,24 +1,24 @@
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.3.0
-  hooks:
-  - id: check-yaml
-  - id: end-of-file-fixer
-  - id: trailing-whitespace
-- repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.1.5
-  hooks:
-    - id: ruff
-      types_or: [ python, pyi, jupyter ]
-      args: [ --fix ]
-    - id: ruff-format
-      types_or: [ python, pyi, jupyter ]
-- repo: https://github.com/pre-commit/mirrors-mypy
-  rev: "586b4f0"
-  hooks:
-  - id: mypy
-    args: [--no-strict-optional, --ignore-missing-imports]
-- repo: https://github.com/igorshubovych/markdownlint-cli
-  rev: v0.32.2
-  hooks:
-  - id: markdownlint
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
+    hooks:
+      - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "586b4f0"
+    hooks:
+      - id: mypy
+        args: [--no-strict-optional, --ignore-missing-imports]
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.32.2
+    hooks:
+      - id: markdownlint

create_pydantic_models.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metobs.smhi.se/api.json --class-name VersionModel --output metobs_versions.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metobs.smhi.se/api/version/1.0.json --class-name ParameterModel --output metobs_parameters.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metobs.smhi.se/api/version/1.0/parameter/1.json --class-name StationModel --output metobs_stations.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metobs.smhi.se/api/version/1.0/parameter/1/station/1.json --class-name PeriodModel --output metobs_periods.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metobs.smhi.se/api/version/1.0/parameter/1/station/1/period/corrected-archive.json --class-name DataModel --output metobs_data.py
+
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/parameter.json --class-name DataModel --output mesan_parameters.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/approvedtime.json --class-name DataModel --output mesan_approved.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/validtime.json --class-name DataModel --output mesan_valid.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/geotype/polygon.json --class-name DataModel --output mesan_polygon.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/geotype/multipoint.json --class-name DataModel --output mesan_multipoint.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/geotype/point/lon/16/lat/58/data.json --class-name DataModel --output mesan_data_point.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url "https://opendata-download-metanalys.smhi.se/api/category/mesan2g/version/1/geotype/multipoint/validtime/20240108T060000Z/parameter/t/leveltype/hl/level/2/data.json?with-geo=true" --class-name DataModel --output mesan_data_multipoint.py
+
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url "https://opendata-download-metanalys.smhi.se/api/category/strang1g/version/1/geotype/point/lon/16.158/lat/58.5812/parameter/118/data.json?from=2020-02-01&to=2020-02-02" --class-name DataModel --output strang_point.py
+datamodel-codegen --output-model-type pydantic_v2.BaseModel --snake-case-field --url "http://opendata-download-metanalys.smhi.se/api/category/strang1g/version/1/geotype/multipoint/validtime/201908/parameter/118/data.json?interval=monthly" --class-name DataModel --output strang_multipoint.py

docs/index.md

@@ -5,7 +5,7 @@ See [https://opendata.smhi.se/apidocs/](https://opendata.smhi.se/apidocs/)
 for a complete list of available APIs.
 SMHI stands for [Swedish Meteorological and Hydrological Institute](https://www.smhi.se/)
 (or in Swedish: Sveriges meteorologiska och hydrologiska institut),
-which is a Swedish agency under its parent department:  Ministry of Climate and
+which is a Swedish agency under its parent department: Ministry of Climate and
 Enterprise.
 
 Initially only these four APIs are supported
@@ -49,7 +49,7 @@ Use this to access data about _forecasts_, i.e. SMHI weather predictions.
 ## Mesan client
 
 Client to fetch data from meteorological analysis.
-Use this to access up to 24 hour predictions of weather parameters.
+Use this to access the last 24 hour predictions of weather parameters.
 This API is a useful complement to Metobs because the number of weather
 stations are limited.
 

docs/mesan-example.md

@@ -1,6 +1,10 @@
 # Example of Mesan direct use
 
-Direct usage of `Mesan`. To list approved and valid times to
+Direct usage of `Mesan`. Note that `Metfcts` and `Mesan` have identical interfaces.
+
+## Time listing
+
+To list approved and valid times to
 
 ```python
 from smhi.mesan import Mesan
@@ -14,6 +18,8 @@ Notice that `approved_time` is the time when the MESAN analysis was updated.
 On the other hand, `valid_time` are valid time stamps to fetch data for,
 see below.
 
+## Parameters and geographic area
+
 To list available parameters, geographic area as polygon and points do
 
 ```python
@@ -27,10 +33,12 @@ client.get_geo_multipoint(2)
 
 where `get_geo_multipoint` accepts a downsample argument.
 
+## Point and multipoint data
+
 To get data, two methods are available.
 `get_point` accepts latitude and longitude arguments.
 `get_multipoint` accepts `validtime`, `parameter`,
-`leveltype`, `level`, `downsample` arguments.
+`leveltype`, `level`, `geo` and `downsample` arguments.
 See above to acquire a valid time and parameter.
 
 ```python
@@ -39,7 +47,7 @@ from smhi.mesan import Mesan
 client = Mesan()
 data = client.get_point(58, 16)
 data = client.get_multipoint(
-    "2022-11-12T23:00:00Z", "t", "hl", 2, 2
+    "2022-11-12T23:00:00Z", "t", "hl", 2, False, 2
 )
 ```
 

docs/mesan-model.md

@@ -0,0 +1,3 @@
+# Mesan models
+
+::: smhi.models.mesan_model

docs/metfcts-example.md

@@ -1,6 +1,10 @@
 # Example of Metfcts direct use
 
-Direct usage of `Metfcts`. To list approved and valid times to
+Direct usage of `Metfcts`. Note that `Mesan` and `Metfcts` have identical interfaces.
+
+## Time listing
+
+To list approved and valid times to
 
 ```python
 from smhi.metfcts import Metfcts
@@ -14,6 +18,8 @@ Notice that `approved_time` is the time when the Metfcts analysis was updated.
 On the other hand, `valid_time` are valid time stamps to fetch data for,
 see below.
 
+## Parameters and geographic area
+
 To list available parameters, geographic area as polygon and points do
 
 ```python
@@ -27,6 +33,8 @@ client.get_geo_multipoint(2)
 
 where `get_geo_multipoint` accepts a downsample argument.
 
+## Point and multipoint data
+
 To get data, two methods are available.
 `get_point` accepts latitude and longitude arguments.
 `get_multipoint` accepts `validtime`, `parameter`,

docs/metfcts-model.md

@@ -0,0 +1,3 @@
+# Metfcts models
+
+::: smhi.models.metfcts_model

docs/metobs-example.md

@@ -2,79 +2,49 @@
 
 Direct usage of `Metobs`.
 
-## Get data from known parameters
-
-To get data from a known station (found e.g. through exploration of
-[https://www.smhi.se/data](https://www.smhi.se/data)) from `Metobs` do
-
-```python
-from smhi.metobs import Metobs
-
-client = Metobs()
-data = client.get_data_stationset(
-    1, 192840, "corrected-archive"
-)
-```
-
-## Get data by inspecting the API
-
-*This will be deprecated in 0.2.0.*
-To inspect the API, the following methods are provided
-The following example is a common pattern of usage
+The `Metobs` clinet consistes of 5 objects
+`Versions, Parameters, Stations, Periods, Data`
+that building up a chain to get data.
 
 ```python
-from smhi.metobs import Metobs
-
-client = Metobs()
-client.get_parameters()
-
-# list all parameters
-client.parameters.data
-
-# get all stations that have data from parameter 1
-client.get_stations(1)
+from smhi.metobs import Versions, Parameters, Stations, Periods, Data
 
-# list all stations
-client.stations.data
+versions = Versions()  # defaults to type = json, this step can be skipped
+versions.data
+# show data from this endpoint
 
-# get all periods that have data from station 1
-client.get_periods(1)
+parameters = Parameters(versions)  # can be called by simply Parameters()
+parameters.data
+# show all available parameters in that API version
 
-# list all periods
-client.periods.data
+stations = Stations(parameters, 1)
+stations.data
+# show all available stations for parameter 1
 
-# inspect client state
-client.inspect()
+periods = Periods(stations, 1)
+periods.data
+# show all available periods of data for station 1
 
-# get data from parameter 1, station 1 and period corrected-archive
-data = client.get_data()
+data = Data(periods)  # defaults to corrected-archive period
+data.df
+# show the station data dataframe
 ```
 
-## Alternative way of using the client
+Note that, the last call gives back a `MetobsDataModel` with four
+dataframes when a single station is used to fetch data as above.
+They are called `station`, `parameter`, `period` and `df`.
 
-Instead of using the `Metobs` client, the objects used by that client can be
-used directly. The following example is a recommended pattern of usage
+It is posible to fetch a station set, that is, data from many stations for
+the last hour as
 
 ```python
-from smhi.metobs import Versions, Parameters, Stations, Periods, Data
-
-versions = Versions()  # defaults to type = json, this step can be skipped
-versions.show
-# print all available versions
-
-parameters = Parameters(versions)  # can be called by simply Parameters()
-parameters.show
-# print all available parameters in that API version
-
-stations = Stations(parameters, 1)
-stations.show
-# print all available stations for parameter 1
-
-periods = Periods(stations, 1)
-periods.show
-# print all available periods of data for station 1
+periods = Periods(stations, station_set="all")
+periods.data
+# show all available periods of data for station set all
 
 data = Data(periods)  # defaults to corrected-archive period
-data.data_header  # data headers
-data.data  # actual data
+data.df
+# show
 ```
+
+in which case only the `parameter` and `df` fields are populated.

docs/metobs-model.md

@@ -0,0 +1,3 @@
+# Metobs models
+
+::: smhi.models.metobs_model

docs/metobs-reference.md

@@ -1,8 +1,8 @@
 # Metobs reference
 
-::: smhi.metobs.Metobs
+::: smhi.metobs.BaseMetobs
 
-::: smhi.metobs.BaseLevel
+::: smhi.metobs.Versions
 
 ::: smhi.metobs.Parameters