Add FlexMeasures plugins, USEF protocol, and Cariflex simulator
- flexmeasures-entsoe: ENTSO-E data plugin - flexmeasures-weather: Weather data plugin - USEF Flex Trading Protocol PDF (2.4MB) - Cariflex simulator (publishes to Redis) - Dashboard Grafana updated with correct InfluxDB queries - All tools extracted in /tools/
This commit is contained in:
Eric F
7
tools/flexmeasures-weather/.flake8
Executable file
7
tools/flexmeasures-weather/.flake8
Executable file
@@ -0,0 +1,7 @@
|
||||
[flake8]
|
||||
exclude = .git,__pycache__,documentation
|
||||
max-line-length = 160
|
||||
max-complexity = 13
|
||||
select = B,C,E,F,W,B9
|
||||
ignore = E501, W503, E203
|
||||
|
||||
2
tools/flexmeasures-weather/.github/issue-branch.yml
vendored
Normal file
2
tools/flexmeasures-weather/.github/issue-branch.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
openDraftPR: true
|
||||
autoCloseIssue: true
|
||||
60
tools/flexmeasures-weather/.github/workflows/lint-and-test.yml
vendored
Normal file
60
tools/flexmeasures-weather/.github/workflows/lint-and-test.yml
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
name: lint-and-test
|
||||
|
||||
on: push
|
||||
|
||||
|
||||
jobs:
|
||||
check:
|
||||
runs-on: ubuntu-latest
|
||||
name: Check (on Python 3.11)
|
||||
steps:
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: 3.11
|
||||
- uses: actions/checkout@v3
|
||||
- uses: pre-commit/action@v3.0.0
|
||||
|
||||
|
||||
test:
|
||||
needs: check
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
py_version: [ '3.11' ]
|
||||
name: "Test (on Python ${{ matrix.py_version }})"
|
||||
steps:
|
||||
- uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: ${{ matrix.py_version }}
|
||||
- name: Check out src from Git
|
||||
uses: actions/checkout@v3
|
||||
- name: Install SQL extensions
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get -y install postgresql-client
|
||||
psql -h $PGHOST -p $PGPORT --file scripts/load-psql-extensions.sql -U $PGUSER $PGDB;
|
||||
- name: Install necessary items for netcdf
|
||||
run: |
|
||||
sudo apt-get install libhdf5-serial-dev netcdf-bin libnetcdf-dev
|
||||
- run: make test
|
||||
env:
|
||||
PGHOST: 127.0.0.1
|
||||
PGPORT: 5432
|
||||
PGUSER: flexmeasures_test
|
||||
PGDB: flexmeasures_test
|
||||
PGPASSWORD: flexmeasures_test
|
||||
|
||||
services:
|
||||
# Label used to access the service container
|
||||
postgres:
|
||||
# Docker Hub image
|
||||
image: postgres:14.17
|
||||
env:
|
||||
POSTGRES_USER: flexmeasures_test
|
||||
POSTGRES_PASSWORD: flexmeasures_test
|
||||
POSTGRES_DB: flexmeasures_test
|
||||
ports:
|
||||
- 5432:5432
|
||||
# needed because the postgres container does not provide a healthcheck
|
||||
options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
|
||||
84
tools/flexmeasures-weather/.gitignore
vendored
Normal file
84
tools/flexmeasures-weather/.gitignore
vendored
Normal file
@@ -0,0 +1,84 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
pip-wheel-metadata/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
|
||||
# custom project files
|
||||
|
||||
.vscode
|
||||
*.pickle
|
||||
|
||||
.ipynb_checkpoints/
|
||||
notebooks/.ipynb_checkpoints/
|
||||
|
||||
flexmeasures.log
|
||||
|
||||
.gitconfig.*
|
||||
19
tools/flexmeasures-weather/.pre-commit-config.yaml
Executable file
19
tools/flexmeasures-weather/.pre-commit-config.yaml
Executable file
@@ -0,0 +1,19 @@
|
||||
repos:
|
||||
- repo: https://github.com/pycqa/flake8
|
||||
rev: 7.1.1 # New version tags can be found here: https://github.com/pycqa/flake8/tags
|
||||
hooks:
|
||||
- id: flake8
|
||||
name: flake8 (code linting)
|
||||
- repo: https://github.com/psf/black
|
||||
rev: 24.8.0 # New version tags can be found here: https://github.com/psf/black/tags
|
||||
hooks:
|
||||
- id: black
|
||||
name: black (code formatting)
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: mypy
|
||||
name: mypy (static typing)
|
||||
pass_filenames: false
|
||||
language: script
|
||||
entry: run_mypy.sh
|
||||
verbose: true
|
||||
174
tools/flexmeasures-weather/LICENSE
Normal file
174
tools/flexmeasures-weather/LICENSE
Normal file
@@ -0,0 +1,174 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
45
tools/flexmeasures-weather/Makefile
Normal file
45
tools/flexmeasures-weather/Makefile
Normal file
@@ -0,0 +1,45 @@
|
||||
# Note: use tabs
|
||||
# actions which are virtual, i.e. not a script
|
||||
.PHONY: install install-for-dev install-deps install-flexmeasures-weather test freeze-deps upgrade-deps
|
||||
|
||||
|
||||
# ---- Development ---
|
||||
|
||||
test:
|
||||
make install-for-dev
|
||||
pytest
|
||||
|
||||
# ---- Installation ---
|
||||
|
||||
install: install-deps install-flexmeasures-weather
|
||||
|
||||
install-for-dev:
|
||||
make freeze-deps
|
||||
pip-sync requirements/app.txt requirements/dev.txt requirements/test.txt
|
||||
make install-flexmeasures-weather
|
||||
pre-commit install
|
||||
|
||||
install-deps:
|
||||
make install-pip-tools
|
||||
make freeze-deps
|
||||
pip-sync requirements/app.txt
|
||||
|
||||
install-flexmeasures-weather:
|
||||
pip install -e .
|
||||
|
||||
install-pip-tools:
|
||||
pip3 install -q "pip-tools>=6.2"
|
||||
|
||||
freeze-deps:
|
||||
make install-pip-tools
|
||||
pip-compile -o requirements/app.txt requirements/app.in
|
||||
pip-compile -o requirements/test.txt requirements/test.in
|
||||
pip-compile -o requirements/dev.txt requirements/dev.in
|
||||
|
||||
upgrade-deps:
|
||||
make install-pip-tools
|
||||
pip-compile --upgrade -o requirements/app.txt requirements/app.in
|
||||
pip-compile --upgrade -o requirements/test.txt requirements/test.in
|
||||
pip-compile --upgrade -o requirements/dev.txt requirements/dev.in
|
||||
make test
|
||||
|
||||
142
tools/flexmeasures-weather/README.md
Normal file
142
tools/flexmeasures-weather/README.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# FLEXMEASURES-WEATHER - a plugin for FlexMeasures to integrate weather forecasts
|
||||
|
||||
|
||||
This plugin currently supports two Weather API services: [OpenWeatherMap One Call API](https://openweathermap.org/api/one-call-3) and [Weather API](https://www.weatherapi.com/). The configuration is controlled via your FlexMeasures config file.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
To register a new weather sensor:
|
||||
|
||||
`flexmeasures weather register-weather-sensor --name "wind speed" --latitude 30 --longitude 40`
|
||||
|
||||
Currently supported: wind speed, temperature & irradiance.
|
||||
|
||||
To collect weather forecasts:
|
||||
|
||||
`flexmeasures weather get-weather-forecasts --location 30,40`
|
||||
|
||||
This saves forecasts for your registered sensors in the database.
|
||||
|
||||
Use the `--help`` option for more options, e.g. for specifying two locations and requesting that a number of weather stations cover the bounding box between them (where the locations represent top left and bottom right).
|
||||
|
||||
Notes about weather sensor setup:
|
||||
|
||||
- Weather sensors are public assets in FlexMeasures. They are accessible by all accounts on a FlexMeasures server.
|
||||
- The resolution is one hour. Weather also supports minutely data within the upcoming hour(s), but that is not supported here.
|
||||
|
||||
An alternative usage is to save raw results in JSON files (for later processing), like this:
|
||||
|
||||
`flexmeasures weather get-weather-forecasts --location 30,40 --store-as-json-files --region somewhere`
|
||||
|
||||
This saves the complete response from the Weather Provider in a local folder (i.e. no sensor registration needed, this is a direct way to use Weather APIs, without FlexMeasures integration). `region` will become a subfolder.
|
||||
|
||||
Finally, note that these APIs allow free calls, but not without limits.
|
||||
For instance, currently 1000 free calls per day can be made to the OpenWeatherMap API,
|
||||
so you can make a call every 15 minutes for up to 10 locations or every hour for up to 40 locations (or get a paid account).
|
||||
|
||||
|
||||
## Setup
|
||||
|
||||
### Installation
|
||||
|
||||
To add as plugin to an existing FlexMeasures system, add "/path/to/flexmeasures-weather-repo/flexmeasures_weather" to your FlexMeasures config file,
|
||||
using the FLEXMEASURES_PLUGINS setting (a list).
|
||||
|
||||
Alternatively, if you installed this plugin as a package (e.g. via `python setup.py install`, `pip install -e` or `pip install flexmeasures_weather` after this project is on Pypi), then "flexmeasures_weather" suffices.
|
||||
|
||||
To enable weather forecast functionality, two PostgreSQL extensions must be installed. Run the following SQL commands in your database:
|
||||
|
||||
```
|
||||
CREATE EXTENSION IF NOT EXISTS cube;
|
||||
CREATE EXTENSION IF NOT EXISTS earthdistance;
|
||||
```
|
||||
|
||||
These extensions provide support for geographical calculations such as `ll_to_earth` and `earth_distance`, which we use to find the nearest weather station asset.
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
Add the following entries to your config:
|
||||
|
||||
```ini
|
||||
# Select the weather provider to use: "OWM" (OpenWeatherMap) or "WAPI" (Weather API)
|
||||
WEATHER_PROVIDER = "OWM"
|
||||
|
||||
# API key for the selected weather provider
|
||||
WEATHERAPI_KEY = "your-api-key-here"
|
||||
|
||||
# Name to register the weather data source in FlexMeasures. The default is 'Weather'.
|
||||
# Examples: "OpenWeatherMap" (for backwards compatibility with the OWM plugin).
|
||||
WEATHER_DATA_SOURCE_NAME = "OpenWeatherMap"
|
||||
|
||||
# File path to store weather data in JSON format
|
||||
WEATHER_FILE_PATH_LOCATION = "/path/to/weather_output.json"
|
||||
```
|
||||
|
||||
### Extending to Other Weather API Services
|
||||
|
||||
To expand the plugin's coverage to additional weather API services:
|
||||
|
||||
1. **Update the configuration**
|
||||
Change the `WEATHER_PROVIDER` setting in your config to the identifier for the new API service (e.g., `NEWAPI`), and provide the necessary credentials in `WEATHERAPI_KEY`.
|
||||
|
||||
2. **Implement a new API function**
|
||||
Create a function named in the format:
|
||||
|
||||
```python
|
||||
def call_NEWAPI_api(...):
|
||||
# Your logic to call the API and return data in the expected format
|
||||
```
|
||||
|
||||
This function should return data in the same structure as used by the original OpenWeatherMap integration, and **must have at least 48 hours of forecast data from the time of the call**.
|
||||
|
||||
You also need a provider-specific mapping entry in `flexmeasures_weather/sensor_specs.py`. Each supported sensor should include the new provider's response field name, for example:
|
||||
|
||||
```python
|
||||
dict(
|
||||
fm_sensor_name="temperature",
|
||||
OWM_sensor_name="temp",
|
||||
WAPI_sensor_name="temp_c",
|
||||
NEWAPI_sensor_name="temperatureC",
|
||||
unit="°C",
|
||||
event_resolution=timedelta(minutes=60),
|
||||
attributes=weather_attributes,
|
||||
)
|
||||
```
|
||||
|
||||
3. **Integrate into the plugin**
|
||||
Modify the `call_api` function in the `weather.py` file to include a conditional branch for the new provider:
|
||||
|
||||
```python
|
||||
def call_api(...):
|
||||
if provider not in ['OWM', 'WAPI', ..., 'NEWAPI']:
|
||||
raise Exception
|
||||
if provider == 'NEWAPI':
|
||||
return call_NEWAPI_api(...)
|
||||
```
|
||||
|
||||
4. **Finalize and contribute**
|
||||
Once you've implemented and tested the plugin with your chosen API service:
|
||||
- Update this README to reflect the new configuration and usage details.
|
||||
- Submit a pull request with your changes for review.
|
||||
|
||||
> This modular structure allows for seamless integration of additional services while maintaining consistency and clarity in data handling.
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
We use pre-commit to keep code quality up.
|
||||
|
||||
Install necessary tools with:
|
||||
|
||||
pip install pre-commit
|
||||
pre-commit install
|
||||
|
||||
or:
|
||||
|
||||
make install-for-dev
|
||||
|
||||
Try it:
|
||||
|
||||
pre-commit run --all-files --show-diff-on-failure
|
||||
BIN
tools/flexmeasures-weather/flexmeasures_weather/.DS_Store
vendored
Normal file
BIN
tools/flexmeasures-weather/flexmeasures_weather/.DS_Store
vendored
Normal file
Binary file not shown.
68
tools/flexmeasures-weather/flexmeasures_weather/__init__.py
Normal file
68
tools/flexmeasures-weather/flexmeasures_weather/__init__.py
Normal file
@@ -0,0 +1,68 @@
|
||||
__version__ = "Unknown version"
|
||||
|
||||
|
||||
"""
|
||||
The __init__ for the flexmeasures-weather FlexMeasures plugin.
|
||||
|
||||
FlexMeasures registers the BluePrint objects it finds in here.
|
||||
"""
|
||||
|
||||
|
||||
from importlib.metadata import version, PackageNotFoundError
|
||||
|
||||
from flask import Blueprint
|
||||
|
||||
from .utils.blueprinting import ensure_bp_routes_are_loaded_fresh
|
||||
|
||||
# Overwriting version (if possible) from the package metadata
|
||||
# ― if this plugin has been installed as a package.
|
||||
# This uses importlib.metadata behaviour added in Python 3.8.
|
||||
# Note that we rely on git tags (via setuptools_scm) to define that version.
|
||||
try:
|
||||
__version__ = version("flexmeasures_weather")
|
||||
except PackageNotFoundError:
|
||||
# package is not installed
|
||||
pass
|
||||
|
||||
|
||||
DEFAULT_FILE_PATH_LOCATION = "weather-forecasts"
|
||||
DEFAULT_DATA_SOURCE_NAME = "Weather"
|
||||
DEFAULT_WEATHER_STATION_NAME = "weather station (created by FM-Weather)"
|
||||
WEATHER_STATION_TYPE_NAME = "weather station"
|
||||
DEFAULT_MAXIMAL_DEGREE_LOCATION_DISTANCE = 1
|
||||
|
||||
__version__ = "0.1"
|
||||
__settings__ = {
|
||||
"WEATHER_FILE_PATH_LOCATION": dict(
|
||||
description="Location of JSON files (if you store weather data in this form). Absolute path.",
|
||||
level="debug",
|
||||
),
|
||||
"WEATHER_DATA_SOURCE_NAME": dict(
|
||||
description=f"Name of the data source for Weather data, defaults to '{DEFAULT_DATA_SOURCE_NAME}'",
|
||||
level="debug",
|
||||
),
|
||||
"WEATHER_STATION_NAME": dict(
|
||||
description=f"Name of the weather station asset, defaults to '{DEFAULT_WEATHER_STATION_NAME}'",
|
||||
level="debug",
|
||||
),
|
||||
"WEATHER_MAXIMAL_DEGREE_LOCATION_DISTANCE": dict(
|
||||
descripion=f"Maximum distance (in degrees latitude & longitude) for weather stations from forecast location, defaults to {DEFAULT_MAXIMAL_DEGREE_LOCATION_DISTANCE}",
|
||||
level="debug",
|
||||
),
|
||||
"WEATHER_PROVIDER": dict(
|
||||
description="Provider for weather data. Permissible options are 'OWM' (OpenWeatherMap) or 'WAPI' (WeatherAPI).",
|
||||
level="error",
|
||||
),
|
||||
"WEATHERAPI_KEY": dict(
|
||||
description="API key for OWM or WAPI, whatever you have chosen.",
|
||||
level="error",
|
||||
),
|
||||
}
|
||||
|
||||
# CLI
|
||||
flexmeasures_weather_bp: Blueprint = Blueprint(
|
||||
"flexmeasures-weather CLI", __name__, cli_group="weather"
|
||||
)
|
||||
flexmeasures_weather_bp.cli.help = "flexmeasures-weather CLI commands"
|
||||
ensure_bp_routes_are_loaded_fresh("cli.commands")
|
||||
from flexmeasures_weather.cli import commands # noqa: E402,F401
|
||||
188
tools/flexmeasures-weather/flexmeasures_weather/cli/commands.py
Normal file
188
tools/flexmeasures-weather/flexmeasures_weather/cli/commands.py
Normal file
@@ -0,0 +1,188 @@
|
||||
from flask import current_app
|
||||
|
||||
from flask.cli import with_appcontext
|
||||
import click
|
||||
from flexmeasures.data.models.time_series import Sensor
|
||||
|
||||
from flexmeasures.data.transactional import task_with_status_report
|
||||
from flexmeasures.data.config import db
|
||||
|
||||
from .. import flexmeasures_weather_bp
|
||||
from .schemas.weather_sensor import WeatherSensorSchema
|
||||
from ..utils.modeling import (
|
||||
get_or_create_weather_station,
|
||||
get_weather_station_by_asset_id,
|
||||
)
|
||||
from ..utils.locating import get_locations, get_location_by_asset_id
|
||||
from ..utils.filing import make_file_path
|
||||
from ..utils.weather import (
|
||||
save_forecasts_in_db,
|
||||
save_forecasts_as_json,
|
||||
get_supported_sensor_spec,
|
||||
)
|
||||
from ..sensor_specs import mapping
|
||||
|
||||
"""
|
||||
TODO: allow to also pass an asset ID or name for the weather station (instead of location) to both commands?
|
||||
See https://github.com/FlexMeasures/flexmeasures-weather
|
||||
"""
|
||||
|
||||
supported_sensors_list = ", ".join(
|
||||
[str(sensor_specs["fm_sensor_name"]) for sensor_specs in mapping]
|
||||
)
|
||||
|
||||
|
||||
@flexmeasures_weather_bp.cli.command("register-weather-sensor")
|
||||
@with_appcontext
|
||||
@click.option(
|
||||
"--name",
|
||||
required=True,
|
||||
help=f"Name of the sensor. Has to be from the supported list ({supported_sensors_list})",
|
||||
)
|
||||
@click.option(
|
||||
"--asset-id",
|
||||
required=False,
|
||||
type=int,
|
||||
help="The asset id of the weather station (you can also give its location).",
|
||||
)
|
||||
@click.option(
|
||||
"--latitude",
|
||||
required=False,
|
||||
type=float,
|
||||
help="Latitude of where you want to measure.",
|
||||
)
|
||||
@click.option(
|
||||
"--longitude",
|
||||
required=False,
|
||||
type=float,
|
||||
help="Longitude of where you want to measure.",
|
||||
)
|
||||
@click.option(
|
||||
"--timezone",
|
||||
default="UTC",
|
||||
help="The timezone of the sensor data as string, e.g. 'UTC' (default) or 'Europe/Amsterdam'",
|
||||
)
|
||||
def add_weather_sensor(**args):
|
||||
"""
|
||||
Add a weather sensor.
|
||||
This will first create a weather station asset if none exists at the location yet.
|
||||
|
||||
"""
|
||||
errors = WeatherSensorSchema().validate(args)
|
||||
if errors:
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] Please correct the following errors:\n{errors}.\n Use the --help flag to learn more."
|
||||
)
|
||||
raise click.Abort
|
||||
if args["asset_id"] is not None:
|
||||
weather_station = get_weather_station_by_asset_id(args["asset_id"])
|
||||
elif args["latitude"] is not None and args["longitude"] is not None:
|
||||
weather_station = get_or_create_weather_station(
|
||||
args["latitude"], args["longitude"]
|
||||
)
|
||||
else:
|
||||
raise Exception(
|
||||
"Arguments are missing to register a weather sensor. Provide either '--asset-id' or ('--latitude' and '--longitude')."
|
||||
)
|
||||
|
||||
sensor = Sensor.query.filter(
|
||||
Sensor.name == args["name"].lower(),
|
||||
Sensor.generic_asset == weather_station,
|
||||
).one_or_none()
|
||||
if sensor:
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] A '{args['name']}' weather sensor already exists at this weather station (the station's ID is {weather_station.id})."
|
||||
)
|
||||
return
|
||||
fm_sensor_specs = get_supported_sensor_spec(args["name"])
|
||||
fm_sensor_specs["generic_asset"] = weather_station
|
||||
fm_sensor_specs["timezone"] = args["timezone"]
|
||||
fm_sensor_specs["name"] = fm_sensor_specs.pop("fm_sensor_name")
|
||||
fm_sensor_specs.pop("OWM_sensor_name")
|
||||
fm_sensor_specs.pop("WAPI_sensor_name")
|
||||
sensor = Sensor(**fm_sensor_specs)
|
||||
sensor.attributes = fm_sensor_specs["attributes"]
|
||||
|
||||
db.session.add(sensor)
|
||||
db.session.commit()
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] Successfully created weather sensor with ID {sensor.id}, at weather station with ID {weather_station.id}"
|
||||
)
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] You can access this sensor at its entity address {sensor.entity_address}"
|
||||
)
|
||||
|
||||
|
||||
@flexmeasures_weather_bp.cli.command("get-weather-forecasts")
|
||||
@with_appcontext
|
||||
@click.option(
|
||||
"--location",
|
||||
type=str,
|
||||
required=False,
|
||||
help='Measurement location(s). "latitude,longitude" or "top-left-latitude,top-left-longitude:'
|
||||
'bottom-right-latitude,bottom-right-longitude." The first format defines one location to measure.'
|
||||
" The second format defines a region of interest with several (>=4) locations"
|
||||
' (see also the "method" and "num_cells" parameters for details on how to use this feature).',
|
||||
)
|
||||
@click.option(
|
||||
"--asset-id",
|
||||
type=int,
|
||||
required=False,
|
||||
help="ID of a weather station asset - forecasts will be gotten for its location. If present, --location will be ignored.",
|
||||
)
|
||||
@click.option(
|
||||
"--store-in-db/--store-as-json-files",
|
||||
default=True,
|
||||
help="Store forecasts in the database, or simply save as json files (defaults to database).",
|
||||
)
|
||||
@click.option(
|
||||
"--num_cells",
|
||||
type=int,
|
||||
default=1,
|
||||
help="Number of cells on the grid. Only used if a region of interest has been mapped in the location parameter. Defaults to 1.",
|
||||
)
|
||||
@click.option(
|
||||
"--method",
|
||||
default="hex",
|
||||
type=click.Choice(["hex", "square"]),
|
||||
help="Grid creation method. Only used if a region of interest has been mapped in the location parameter.",
|
||||
)
|
||||
@click.option(
|
||||
"--region",
|
||||
type=str,
|
||||
default="",
|
||||
help="Name of the region (will create sub-folder if you store json files).",
|
||||
)
|
||||
@task_with_status_report("get-weather-forecasts")
|
||||
def collect_weather_data(location, asset_id, store_in_db, num_cells, method, region):
|
||||
"""
|
||||
Collect weather forecasts from the Weather Provider API.
|
||||
This will be done for one or more locations, for which we first identify relevant weather stations.
|
||||
|
||||
This function can get weather data for one location or for several locations within
|
||||
a geometrical grid (See the --location parameter).
|
||||
"""
|
||||
|
||||
api_key = str(
|
||||
current_app.config.get(
|
||||
"WEATHERAPI_KEY", current_app.config.get("OPENWEATHERMAP_API_KEY", "")
|
||||
)
|
||||
)
|
||||
if api_key == "":
|
||||
raise Exception("[FLEXMEASURES-WEATHER] Setting WEATHERAPI_KEY not available.")
|
||||
if asset_id is not None:
|
||||
locations = [get_location_by_asset_id(asset_id)]
|
||||
elif location is not None:
|
||||
locations = get_locations(location, num_cells, method)
|
||||
else:
|
||||
raise Warning(
|
||||
"[FLEXMEASURES-WEATHER] Pass either location or asset-id to get weather forecasts."
|
||||
)
|
||||
|
||||
# Save the results
|
||||
if store_in_db:
|
||||
save_forecasts_in_db(api_key, locations)
|
||||
else:
|
||||
save_forecasts_as_json(
|
||||
api_key, locations, data_path=make_file_path(current_app, region)
|
||||
)
|
||||
@@ -0,0 +1,43 @@
|
||||
from marshmallow import (
|
||||
Schema,
|
||||
validates,
|
||||
ValidationError,
|
||||
fields,
|
||||
validate,
|
||||
)
|
||||
|
||||
import pytz
|
||||
|
||||
from ...utils.weather import get_supported_sensor_spec, get_supported_sensors_str
|
||||
|
||||
|
||||
class WeatherSensorSchema(Schema):
|
||||
"""
|
||||
Schema for the weather sensor registration.
|
||||
Based on flexmeasures.Sensor, plus some attributes for the weather station asset.
|
||||
"""
|
||||
|
||||
name = fields.Str(required=True)
|
||||
timezone = fields.Str()
|
||||
asset_id = fields.Int(required=False, allow_none=True)
|
||||
latitude = fields.Float(
|
||||
required=False, validate=validate.Range(min=-90, max=90), allow_none=True
|
||||
)
|
||||
longitude = fields.Float(
|
||||
required=False, validate=validate.Range(min=-180, max=180), allow_none=True
|
||||
)
|
||||
|
||||
@validates("name")
|
||||
def validate_name_is_supported(self, name: str, **kwargs):
|
||||
if get_supported_sensor_spec(name):
|
||||
return
|
||||
raise ValidationError(
|
||||
f"Weather sensors with name '{name}' are not supported by flexmeasures-weather. For now, the following is supported: [{get_supported_sensors_str()}]"
|
||||
)
|
||||
|
||||
@validates("timezone")
|
||||
def validate_timezone(self, timezone: str, **kwargs):
|
||||
try:
|
||||
pytz.timezone(timezone)
|
||||
except pytz.UnknownTimeZoneError:
|
||||
raise ValidationError(f"Timezone {timezone} is unknown!")
|
||||
@@ -0,0 +1 @@
|
||||
from flexmeasures.conftest import run_as_cli # noqa: F401
|
||||
@@ -0,0 +1,105 @@
|
||||
import logging
|
||||
|
||||
import pytest
|
||||
from flexmeasures.data.models.time_series import TimedBelief
|
||||
|
||||
from ..commands import collect_weather_data
|
||||
from ...utils import weather
|
||||
from .utils import mock_api_response
|
||||
|
||||
|
||||
"""
|
||||
Useful resource: https://flask.palletsprojects.com/en/2.0.x/testing/#testing-cli-commands
|
||||
"""
|
||||
|
||||
|
||||
def test_get_weather_forecasts_to_db(
|
||||
app, fresh_db, monkeypatch, run_as_cli, add_weather_sensors_fresh_db
|
||||
):
|
||||
"""
|
||||
Test if we can process forecast and save them to the database.
|
||||
"""
|
||||
wind_sensor = add_weather_sensors_fresh_db["wind"]
|
||||
fresh_db.session.flush()
|
||||
wind_sensor_id = wind_sensor.id
|
||||
weather_station = wind_sensor.generic_asset
|
||||
|
||||
monkeypatch.setitem(app.config, "WEATHERAPI_KEY", "dummy")
|
||||
monkeypatch.setitem(app.config, "WEATHER_PROVIDER", "OWM")
|
||||
monkeypatch.setattr(weather, "call_api", mock_api_response)
|
||||
|
||||
runner = app.test_cli_runner()
|
||||
result = runner.invoke(
|
||||
collect_weather_data,
|
||||
["--location", f"{weather_station.latitude},{weather_station.longitude}"],
|
||||
)
|
||||
print(result.output)
|
||||
assert "Reported task get-weather-forecasts status as True" in result.output
|
||||
|
||||
beliefs = (
|
||||
fresh_db.session.query(TimedBelief)
|
||||
.filter(TimedBelief.sensor_id == wind_sensor_id)
|
||||
.all()
|
||||
)
|
||||
assert len(beliefs) == 2
|
||||
for wind_speed in (100, 90):
|
||||
assert wind_speed in [belief.event_value for belief in beliefs]
|
||||
|
||||
|
||||
def test_get_weather_forecasts_wapi_mapping(
|
||||
app, fresh_db, monkeypatch, run_as_cli, add_weather_sensors_fresh_db
|
||||
):
|
||||
"""
|
||||
Test that WeatherAPI provider-specific field names are mapped independently.
|
||||
"""
|
||||
wind_sensor = add_weather_sensors_fresh_db["wind"]
|
||||
fresh_db.session.flush()
|
||||
wind_sensor_id = wind_sensor.id
|
||||
weather_station = wind_sensor.generic_asset
|
||||
|
||||
monkeypatch.setitem(app.config, "WEATHERAPI_KEY", "dummy")
|
||||
monkeypatch.setitem(app.config, "WEATHER_PROVIDER", "WAPI")
|
||||
monkeypatch.setattr(weather, "call_api", mock_api_response)
|
||||
|
||||
runner = app.test_cli_runner()
|
||||
result = runner.invoke(
|
||||
collect_weather_data,
|
||||
["--location", f"{weather_station.latitude},{weather_station.longitude}"],
|
||||
)
|
||||
assert "Reported task get-weather-forecasts status as True" in result.output
|
||||
|
||||
beliefs = (
|
||||
fresh_db.session.query(TimedBelief)
|
||||
.filter(TimedBelief.sensor_id == wind_sensor_id)
|
||||
.all()
|
||||
)
|
||||
assert len(beliefs) == 2
|
||||
expected_values = [pytest.approx(100 / 3.6), pytest.approx(90 / 3.6)]
|
||||
assert [belief.event_value for belief in beliefs] == expected_values
|
||||
|
||||
|
||||
def test_get_weather_forecasts_no_close_sensors(
|
||||
app, db, monkeypatch, run_as_cli, add_weather_sensors_fresh_db, caplog
|
||||
):
|
||||
"""
|
||||
Looking for a location too far away from existing weather station.
|
||||
Check we get a warning.
|
||||
"""
|
||||
weather_station = add_weather_sensors_fresh_db["wind"].generic_asset
|
||||
|
||||
monkeypatch.setitem(app.config, "WEATHERAPI_KEY", "dummy")
|
||||
monkeypatch.setitem(app.config, "WEATHER_PROVIDER", "OWM")
|
||||
monkeypatch.setattr(weather, "call_api", mock_api_response)
|
||||
|
||||
runner = app.test_cli_runner()
|
||||
with caplog.at_level(logging.WARNING):
|
||||
result = runner.invoke(
|
||||
collect_weather_data,
|
||||
[
|
||||
"--location",
|
||||
f"{weather_station.latitude - 5},{weather_station.longitude}",
|
||||
],
|
||||
)
|
||||
print(result.output)
|
||||
assert "Reported task get-weather-forecasts status as True" in result.output
|
||||
assert "no sufficiently close weather sensor found" in caplog.text
|
||||
@@ -0,0 +1,47 @@
|
||||
import pytest
|
||||
from flexmeasures import Sensor
|
||||
|
||||
from ..commands import add_weather_sensor
|
||||
from .utils import cli_params_from_dict
|
||||
|
||||
|
||||
"""
|
||||
Useful resource: https://flask.palletsprojects.com/en/2.0.x/testing/#testing-cli-commands
|
||||
"""
|
||||
|
||||
sensor_params = {"name": "wind speed", "latitude": 30, "longitude": 40}
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"invalid_param, invalid_value, expected_msg",
|
||||
[
|
||||
("name", "windd-speed", "not supported by flexmeasures-weather"),
|
||||
("latitude", 93, "less than or equal to 90"),
|
||||
("timezone", "Erope/Amsterdam", "is unknown"),
|
||||
],
|
||||
)
|
||||
def test_register_weather_sensor_invalid_data(
|
||||
app, db, invalid_param, invalid_value, expected_msg
|
||||
):
|
||||
test_sensor_params = sensor_params.copy()
|
||||
test_sensor_params[invalid_param] = invalid_value
|
||||
runner = app.test_cli_runner()
|
||||
result = runner.invoke(add_weather_sensor, cli_params_from_dict(test_sensor_params))
|
||||
assert "Aborted" in result.output
|
||||
assert expected_msg in result.output
|
||||
|
||||
|
||||
def test_register_weather_sensor(app, fresh_db):
|
||||
runner = app.test_cli_runner()
|
||||
result = runner.invoke(add_weather_sensor, cli_params_from_dict(sensor_params))
|
||||
assert "Successfully created weather sensor with ID" in result.output
|
||||
sensor = Sensor.query.filter(Sensor.name == sensor_params["name"]).one_or_none()
|
||||
assert sensor is not None
|
||||
|
||||
|
||||
def test_register_weather_sensor_twice(app, fresh_db):
|
||||
runner = app.test_cli_runner()
|
||||
result = runner.invoke(add_weather_sensor, cli_params_from_dict(sensor_params))
|
||||
assert "Successfully created weather sensor with ID" in result.output
|
||||
result = runner.invoke(add_weather_sensor, cli_params_from_dict(sensor_params))
|
||||
assert "already exists" in result.output
|
||||
@@ -0,0 +1,37 @@
|
||||
from typing import List
|
||||
from datetime import datetime, timedelta
|
||||
from flask import current_app
|
||||
from flexmeasures.utils.time_utils import as_server_time, get_timezone
|
||||
|
||||
|
||||
def cli_params_from_dict(d) -> List[str]:
|
||||
cli_params = []
|
||||
for k, v in d.items():
|
||||
cli_params.append(f"--{k}")
|
||||
cli_params.append(v)
|
||||
return cli_params
|
||||
|
||||
|
||||
def mock_api_response(api_key, location):
|
||||
mock_date = datetime.now()
|
||||
mock_date_tz_aware = as_server_time(
|
||||
datetime.fromtimestamp(mock_date.timestamp(), tz=get_timezone())
|
||||
).replace(second=0, microsecond=0)
|
||||
|
||||
provider = str(current_app.config.get("WEATHER_PROVIDER", ""))
|
||||
date_key = "dt"
|
||||
temp_key = "temp"
|
||||
wind_speed_key = "wind_speed"
|
||||
if provider == "WAPI":
|
||||
date_key = "time_epoch"
|
||||
temp_key = "temp_c"
|
||||
wind_speed_key = "wind_kph"
|
||||
|
||||
return mock_date_tz_aware, [
|
||||
{date_key: mock_date.timestamp(), temp_key: 40, wind_speed_key: 100},
|
||||
{
|
||||
date_key: (mock_date + timedelta(hours=1)).timestamp(),
|
||||
temp_key: 42,
|
||||
wind_speed_key: 90,
|
||||
},
|
||||
]
|
||||
72
tools/flexmeasures-weather/flexmeasures_weather/conftest.py
Normal file
72
tools/flexmeasures-weather/flexmeasures_weather/conftest.py
Normal file
@@ -0,0 +1,72 @@
|
||||
from typing import Dict
|
||||
from datetime import timedelta
|
||||
|
||||
import pytest
|
||||
from flask_sqlalchemy import SQLAlchemy
|
||||
from flexmeasures.app import create as create_flexmeasures_app
|
||||
from flexmeasures.conftest import db, fresh_db # noqa: F401
|
||||
from flexmeasures.data.models.generic_assets import GenericAsset, GenericAssetType
|
||||
from flexmeasures.data.models.time_series import Sensor
|
||||
|
||||
from flexmeasures_weather import WEATHER_STATION_TYPE_NAME
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def app():
|
||||
print("APP FIXTURE")
|
||||
|
||||
# Adding this plugin, making sure the name is known (as last part of plugin path)
|
||||
test_app = create_flexmeasures_app(
|
||||
env="testing", plugins=["../flexmeasures_weather"]
|
||||
)
|
||||
|
||||
# Establish an application context before running the tests.
|
||||
ctx = test_app.app_context()
|
||||
ctx.push()
|
||||
|
||||
yield test_app
|
||||
|
||||
ctx.pop()
|
||||
|
||||
print("DONE WITH APP FIXTURE")
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def add_weather_sensors(db) -> Dict[str, Sensor]: # noqa: F811
|
||||
return create_weather_sensors(db)
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def add_weather_sensors_fresh_db(fresh_db) -> Dict[str, Sensor]: # noqa: F811
|
||||
return create_weather_sensors(fresh_db)
|
||||
|
||||
|
||||
def create_weather_sensors(db: SQLAlchemy): # noqa: F811
|
||||
"""Add a weather station asset with two weather sensors."""
|
||||
weather_station_type = GenericAssetType(name=WEATHER_STATION_TYPE_NAME)
|
||||
db.session.add(weather_station_type)
|
||||
|
||||
weather_station = GenericAsset(
|
||||
name="Test weather station",
|
||||
generic_asset_type=weather_station_type,
|
||||
latitude=33.4843866,
|
||||
longitude=126,
|
||||
)
|
||||
db.session.add(weather_station)
|
||||
|
||||
wind_sensor = Sensor(
|
||||
name="wind speed",
|
||||
generic_asset=weather_station,
|
||||
event_resolution=timedelta(minutes=60),
|
||||
unit="m/s",
|
||||
)
|
||||
db.session.add(wind_sensor)
|
||||
|
||||
temp_sensor = Sensor(
|
||||
name="temperature",
|
||||
generic_asset=weather_station,
|
||||
event_resolution=timedelta(minutes=60),
|
||||
unit="°C",
|
||||
)
|
||||
db.session.add(temp_sensor)
|
||||
return {"wind": wind_sensor, "temperature": temp_sensor}
|
||||
@@ -0,0 +1,51 @@
|
||||
from datetime import timedelta
|
||||
|
||||
|
||||
"""
|
||||
This maps sensor specs which we can use in FlexMeasures to Weather labels.
|
||||
Note: Sensor names we use in FM need to be unique per weather station.
|
||||
At the moment, we only extract from Weather hourly data.
|
||||
"""
|
||||
|
||||
|
||||
weather_attributes = {
|
||||
"daily_seasonality": True,
|
||||
"weekly_seasonality": False,
|
||||
"yearly_seasonality": True,
|
||||
}
|
||||
|
||||
|
||||
mapping = [
|
||||
dict(
|
||||
fm_sensor_name="temperature",
|
||||
OWM_sensor_name="temp",
|
||||
WAPI_sensor_name="temp_c",
|
||||
unit="°C",
|
||||
event_resolution=timedelta(minutes=60),
|
||||
attributes=weather_attributes,
|
||||
),
|
||||
dict(
|
||||
fm_sensor_name="wind speed",
|
||||
OWM_sensor_name="wind_speed",
|
||||
WAPI_sensor_name="wind_kph",
|
||||
unit="m/s",
|
||||
event_resolution=timedelta(minutes=60),
|
||||
attributes=weather_attributes,
|
||||
),
|
||||
dict(
|
||||
fm_sensor_name="cloud cover",
|
||||
OWM_sensor_name="clouds",
|
||||
WAPI_sensor_name="cloud",
|
||||
unit="%",
|
||||
event_resolution=timedelta(minutes=60),
|
||||
attributes=weather_attributes,
|
||||
),
|
||||
dict(
|
||||
fm_sensor_name="irradiance", # in save_forecasts_to_db, we catch this name and do the actual computation to get to the irradiance
|
||||
OWM_sensor_name="clouds",
|
||||
WAPI_sensor_name="cloud",
|
||||
unit="W/m²",
|
||||
event_resolution=timedelta(minutes=60),
|
||||
attributes=weather_attributes,
|
||||
),
|
||||
]
|
||||
BIN
tools/flexmeasures-weather/flexmeasures_weather/utils/.DS_Store
vendored
Normal file
BIN
tools/flexmeasures-weather/flexmeasures_weather/utils/.DS_Store
vendored
Normal file
Binary file not shown.
@@ -0,0 +1,22 @@
|
||||
import sys
|
||||
import importlib
|
||||
|
||||
|
||||
def ensure_bp_routes_are_loaded_fresh(module_name):
|
||||
"""
|
||||
Reload a module if it has been loaded before.
|
||||
It's useful for situations in which some other process has read
|
||||
the module before, but you need some action to happen which only
|
||||
happens during module import ― decorators are a good example.
|
||||
|
||||
One use case is pytest, which reads all python code when it collects tests.
|
||||
In our case, that happens before FlexMeasures' import mechanism
|
||||
has had a chance to know which blueprints a plugin has.
|
||||
Seemingly, the importing code (plugin's __init__) can be imported later
|
||||
than the imported module (containing @route decorators).
|
||||
Re-importing helps to get this order right when FlexMeasures reads the
|
||||
plugin's __init__.
|
||||
"""
|
||||
m_name = "flexmeasures_weather." + module_name
|
||||
if m_name in sys.modules:
|
||||
importlib.reload(sys.modules[m_name])
|
||||
@@ -0,0 +1,25 @@
|
||||
import os
|
||||
|
||||
import click
|
||||
from flask import Flask, current_app
|
||||
|
||||
from flexmeasures_weather import DEFAULT_FILE_PATH_LOCATION
|
||||
|
||||
|
||||
def make_file_path(app: Flask, region: str) -> str:
|
||||
"""Ensure and return path for weather data"""
|
||||
file_path = current_app.config.get(
|
||||
"WEATHER_FILE_PATH_LOCATION", DEFAULT_FILE_PATH_LOCATION
|
||||
)
|
||||
data_path = os.path.join(app.root_path, file_path)
|
||||
if not os.path.exists(data_path):
|
||||
click.echo("[FLEXMEASURES-WEATHER] Creating %s ..." % data_path)
|
||||
os.mkdir(data_path)
|
||||
# optional: extend with subpath for region
|
||||
if region is not None and region != "":
|
||||
region_data_path = "%s/%s" % (data_path, region)
|
||||
if not os.path.exists(region_data_path):
|
||||
click.echo("[FLEXMEASURES-WEATHER] Creating %s ..." % region_data_path)
|
||||
os.mkdir(region_data_path)
|
||||
data_path = region_data_path
|
||||
return data_path
|
||||
@@ -0,0 +1,127 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Tuple, List, Optional
|
||||
|
||||
import click
|
||||
from flask import current_app
|
||||
|
||||
from flexmeasures.utils.grid_cells import LatLngGrid, get_cell_nums
|
||||
from flexmeasures import Sensor
|
||||
from flexmeasures.data.models.generic_assets import GenericAsset
|
||||
from flexmeasures.utils import flexmeasures_inflection
|
||||
|
||||
from .. import WEATHER_STATION_TYPE_NAME
|
||||
|
||||
|
||||
def get_locations(
|
||||
location: str,
|
||||
num_cells: int,
|
||||
method: str,
|
||||
) -> List[Tuple[float, float]]:
|
||||
"""
|
||||
Get locations for getting forecasts for, by parsing the location string, which possibly opens a latitude/longitude grid with several neatly ordered locations.
|
||||
"""
|
||||
if (
|
||||
location.count(",") == 0
|
||||
or location.count(",") != location.count(":") + 1
|
||||
or location.count(":") == 1
|
||||
and (
|
||||
location.find(",") > location.find(":")
|
||||
or location.find(",", location.find(",") + 1) < location.find(":")
|
||||
)
|
||||
):
|
||||
raise Exception(
|
||||
'[FLEXMEASURES-WEATHER] location parameter "%s" seems malformed. Please use "latitude,longitude" or '
|
||||
' "top-left-latitude,top-left-longitude:bottom-right-latitude,bottom-right-longitude"'
|
||||
% location
|
||||
)
|
||||
|
||||
location_identifiers = tuple(location.split(":"))
|
||||
|
||||
if len(location_identifiers) == 1:
|
||||
ll = location_identifiers[0].split(",")
|
||||
locations = [(float(ll[0]), float(ll[1]))]
|
||||
click.echo("[FLEXMEASURES-WEATHER] Only one location: %s,%s." % locations[0])
|
||||
elif len(location_identifiers) == 2:
|
||||
click.echo(
|
||||
"[FLEXMEASURES-WEATHER] Making a grid of locations between top/left %s and bottom/right %s ..."
|
||||
% location_identifiers
|
||||
)
|
||||
top_left = tuple(float(s) for s in location_identifiers[0].split(","))
|
||||
if len(top_left) != 2:
|
||||
raise Exception(
|
||||
"[FLEXMEASURES-WEATHER] top-left parameter '%s' is invalid."
|
||||
% location_identifiers[0]
|
||||
)
|
||||
bottom_right = tuple(float(s) for s in location_identifiers[1].split(","))
|
||||
if len(bottom_right) != 2:
|
||||
raise Exception(
|
||||
"[FLEXMEASURES-WEATHER] bottom-right parameter '%s' is invalid."
|
||||
% location_identifiers[1]
|
||||
)
|
||||
|
||||
num_lat, num_lng = get_cell_nums(top_left, bottom_right, num_cells)
|
||||
|
||||
locations = LatLngGrid(
|
||||
top_left=top_left,
|
||||
bottom_right=bottom_right,
|
||||
num_cells_lat=num_lat,
|
||||
num_cells_lng=num_lng,
|
||||
).get_locations(method)
|
||||
else:
|
||||
raise Exception(
|
||||
"[FLEXMEASURES-WEATHER] location parameter '%s' has too many locations."
|
||||
% location
|
||||
)
|
||||
return locations
|
||||
|
||||
|
||||
def find_weather_sensor_by_location(
|
||||
location: Tuple[float, float],
|
||||
max_degree_difference_for_nearest_weather_sensor: int,
|
||||
sensor_name: str,
|
||||
) -> Sensor | None:
|
||||
"""
|
||||
Try to find a weather sensor of fitting type close by.
|
||||
Return None if the nearest weather sensor is further away than some minimum degrees or if no sensor was found at all.
|
||||
"""
|
||||
weather_sensor: Optional[Sensor] = Sensor.find_closest(
|
||||
generic_asset_type_name=WEATHER_STATION_TYPE_NAME,
|
||||
sensor_name=sensor_name,
|
||||
lat=location[0],
|
||||
lng=location[1],
|
||||
n=1,
|
||||
)
|
||||
if weather_sensor is None:
|
||||
current_app.logger.warning(
|
||||
"[FLEXMEASURES-WEATHER] No weather sensor set up yet for measuring %s. Try the register-weather-sensor CLI task."
|
||||
% sensor_name
|
||||
)
|
||||
return None
|
||||
weather_station: GenericAsset = weather_sensor.generic_asset
|
||||
if abs(
|
||||
location[0] - weather_station.location[0]
|
||||
) > max_degree_difference_for_nearest_weather_sensor or abs(
|
||||
location[1] - weather_station.location[1]
|
||||
> max_degree_difference_for_nearest_weather_sensor
|
||||
):
|
||||
current_app.logger.warning(
|
||||
f"[FLEXMEASURES-WEATHER] We found a weather station, but no sufficiently close weather sensor found (within {max_degree_difference_for_nearest_weather_sensor} {flexmeasures_inflection.pluralize('degree', max_degree_difference_for_nearest_weather_sensor)} distance) for measuring {sensor_name}! We're looking for: {location}, closest available: ({weather_station.location})"
|
||||
)
|
||||
return None
|
||||
return weather_sensor
|
||||
|
||||
|
||||
def get_location_by_asset_id(asset_id: int) -> Tuple[float, float]:
|
||||
"""Get location for forecasting by passing an asset id"""
|
||||
asset = GenericAsset.query.filter(GenericAsset.id == asset_id).one_or_none()
|
||||
if asset.generic_asset_type.name != WEATHER_STATION_TYPE_NAME:
|
||||
raise Exception(
|
||||
f"Asset {asset} does not seem to be a weather station we should use ― we expect an asset with type '{WEATHER_STATION_TYPE_NAME}'."
|
||||
)
|
||||
if asset is None:
|
||||
raise Exception(
|
||||
"[FLEXMEASURES-WEATHER] No asset found for the given asset id %s."
|
||||
% asset_id
|
||||
)
|
||||
return (asset.latitude, asset.longitude)
|
||||
@@ -0,0 +1,124 @@
|
||||
from packaging import version
|
||||
|
||||
from flask import current_app
|
||||
from flexmeasures.data.models.generic_assets import GenericAsset, GenericAssetType
|
||||
from flexmeasures import Source, __version__ as flexmeasures_version
|
||||
from flexmeasures.data import db
|
||||
from flexmeasures.data.services.data_sources import get_or_create_source
|
||||
|
||||
from flexmeasures_weather import DEFAULT_DATA_SOURCE_NAME
|
||||
from flexmeasures_weather import WEATHER_STATION_TYPE_NAME
|
||||
from flexmeasures_weather import DEFAULT_WEATHER_STATION_NAME
|
||||
|
||||
|
||||
if version.parse(flexmeasures_version) < version.parse("0.13"):
|
||||
SOURCE_TYPE = "forecasting script"
|
||||
else:
|
||||
SOURCE_TYPE = "forecaster"
|
||||
|
||||
FM_SUPPORTS_ACCOUNT_LINKED_SOURCES = version.parse(
|
||||
flexmeasures_version
|
||||
) >= version.parse("0.32")
|
||||
|
||||
if FM_SUPPORTS_ACCOUNT_LINKED_SOURCES:
|
||||
from flexmeasures import Account
|
||||
else:
|
||||
Account = None
|
||||
|
||||
|
||||
def get_or_create_weather_account():
|
||||
"""Make sure we have an account for the weather provider service."""
|
||||
if Account is None:
|
||||
raise RuntimeError(
|
||||
"FlexMeasures Account model is unavailable before FlexMeasures 0.32."
|
||||
)
|
||||
account_name = current_app.config.get(
|
||||
"WEATHER_DATA_SOURCE_NAME", DEFAULT_DATA_SOURCE_NAME
|
||||
)
|
||||
weather_account = Account.query.filter(
|
||||
Account.name == account_name,
|
||||
).one_or_none()
|
||||
if weather_account is None:
|
||||
weather_account = Account(name=account_name)
|
||||
db.session.add(weather_account)
|
||||
db.session.flush()
|
||||
return weather_account
|
||||
|
||||
|
||||
def get_or_create_owm_data_source() -> Source:
|
||||
"""Make sure we have a weather provider data source of the configured type."""
|
||||
source_kwargs = dict(
|
||||
source=current_app.config.get(
|
||||
"WEATHER_DATA_SOURCE_NAME", DEFAULT_DATA_SOURCE_NAME
|
||||
),
|
||||
source_type=SOURCE_TYPE,
|
||||
flush=False,
|
||||
)
|
||||
if FM_SUPPORTS_ACCOUNT_LINKED_SOURCES:
|
||||
source_kwargs["account"] = get_or_create_weather_account()
|
||||
return get_or_create_source(**source_kwargs)
|
||||
|
||||
|
||||
def get_or_create_owm_data_source_for_derived_data() -> Source:
|
||||
owm_source_name = current_app.config.get(
|
||||
"WEATHER_DATA_SOURCE_NAME", DEFAULT_DATA_SOURCE_NAME
|
||||
)
|
||||
source_kwargs = dict(
|
||||
source=f"FlexMeasures {owm_source_name}",
|
||||
source_type=SOURCE_TYPE,
|
||||
flush=False,
|
||||
)
|
||||
if FM_SUPPORTS_ACCOUNT_LINKED_SOURCES:
|
||||
source_kwargs["account"] = get_or_create_weather_account()
|
||||
return get_or_create_source(**source_kwargs)
|
||||
|
||||
|
||||
def get_or_create_weather_station_type() -> GenericAssetType:
|
||||
"""Make sure a weather station type exists"""
|
||||
weather_station_type = GenericAssetType.query.filter(
|
||||
GenericAssetType.name == WEATHER_STATION_TYPE_NAME,
|
||||
).one_or_none()
|
||||
if weather_station_type is None:
|
||||
weather_station_type = GenericAssetType(
|
||||
name=WEATHER_STATION_TYPE_NAME,
|
||||
description="A weather station with various sensors.",
|
||||
)
|
||||
db.session.add(weather_station_type)
|
||||
return weather_station_type
|
||||
|
||||
|
||||
def get_or_create_weather_station(latitude: float, longitude: float) -> GenericAsset:
|
||||
"""Make sure a weather station exists at this location."""
|
||||
station_name = current_app.config.get(
|
||||
"WEATHER_STATION_NAME", DEFAULT_WEATHER_STATION_NAME
|
||||
)
|
||||
weather_station = GenericAsset.query.filter(
|
||||
GenericAsset.latitude == latitude, GenericAsset.longitude == longitude
|
||||
).one_or_none()
|
||||
if weather_station is None:
|
||||
weather_station_type = get_or_create_weather_station_type()
|
||||
weather_station = GenericAsset(
|
||||
name=station_name,
|
||||
generic_asset_type=weather_station_type,
|
||||
latitude=latitude,
|
||||
longitude=longitude,
|
||||
)
|
||||
db.session.add(weather_station)
|
||||
return weather_station
|
||||
|
||||
|
||||
def get_weather_station_by_asset_id(asset_id: int) -> GenericAsset:
|
||||
weather_station = GenericAsset.query.filter(
|
||||
GenericAsset.generic_asset_type_id == asset_id
|
||||
).one_or_none()
|
||||
if weather_station is None:
|
||||
raise Exception(
|
||||
f"[FLEXMEASURES-WEATHER] Weather station is not present for the given asset id '{asset_id}'."
|
||||
)
|
||||
|
||||
if weather_station.latitude is None or weather_station.longitude is None:
|
||||
raise Exception(
|
||||
f"[FLEXMEASURES-WEATHER] Weather station {weather_station} is missing location information [Latitude, Longitude]."
|
||||
)
|
||||
|
||||
return weather_station
|
||||
@@ -0,0 +1,37 @@
|
||||
from datetime import datetime
|
||||
|
||||
import pandas as pd
|
||||
from pvlib.location import Location
|
||||
|
||||
|
||||
def compute_irradiance(
|
||||
latitude: float, longitude: float, dt: datetime, cloud_coverage: float
|
||||
) -> float:
|
||||
"""Compute the irradiance received on a location at a specific time.
|
||||
This uses pvlib to
|
||||
1) compute clear-sky irradiance as Global Horizontal Irradiance (GHI),
|
||||
which includes both Direct Normal Irradiance (DNI)
|
||||
and Diffuse Horizontal Irradiance (DHI).
|
||||
2) adjust the GHI for cloud coverage
|
||||
"""
|
||||
site = Location(latitude, longitude, tz=dt.tzinfo)
|
||||
solpos = site.get_solarposition(pd.DatetimeIndex([dt]))
|
||||
ghi_clear = site.get_clearsky(pd.DatetimeIndex([dt]), solar_position=solpos).loc[
|
||||
dt
|
||||
]["ghi"]
|
||||
return ghi_clear_to_ghi(ghi_clear, cloud_coverage)
|
||||
|
||||
|
||||
def ghi_clear_to_ghi(ghi_clear: float, cloud_coverage: float) -> float:
|
||||
"""Compute global horizontal irradiance (GHI) from clear-sky GHI, given a cloud coverage between 0 and 1.
|
||||
|
||||
References
|
||||
----------
|
||||
Perez, R., Moore, K., Wilcox, S., Renne, D., Zelenka, A., 2007.
|
||||
Forecasting solar radiation – preliminary evaluation of an
|
||||
approach based upon the national forecast database. Solar Energy
|
||||
81, 809–812.
|
||||
"""
|
||||
if cloud_coverage < 0 or cloud_coverage > 1:
|
||||
raise ValueError("cloud_coverage should lie in the interval [0, 1]")
|
||||
return (1 - 0.87 * cloud_coverage**1.9) * ghi_clear
|
||||
@@ -0,0 +1,194 @@
|
||||
from types import SimpleNamespace
|
||||
|
||||
import pytest
|
||||
|
||||
from flexmeasures import Asset
|
||||
|
||||
import flexmeasures_weather.utils.modeling as modeling
|
||||
from flexmeasures_weather import DEFAULT_DATA_SOURCE_NAME, DEFAULT_WEATHER_STATION_NAME
|
||||
from flexmeasures_weather.utils.modeling import (
|
||||
FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
SOURCE_TYPE,
|
||||
get_or_create_owm_data_source,
|
||||
get_or_create_owm_data_source_for_derived_data,
|
||||
get_or_create_weather_account,
|
||||
get_or_create_weather_station,
|
||||
)
|
||||
|
||||
|
||||
def test_creating_two_weather_stations(fresh_db):
|
||||
get_or_create_weather_station(50, 40)
|
||||
get_or_create_weather_station(40, 50)
|
||||
assert Asset.query.filter(Asset.name == DEFAULT_WEATHER_STATION_NAME).count() == 2
|
||||
|
||||
|
||||
# The version-branch tests below still use monkeypatching to isolate source
|
||||
# creation side effects without requiring multiple FlexMeasures installs.
|
||||
@pytest.mark.skipif(
|
||||
not FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Weather source accounts are only supported on FlexMeasures >= 0.32.",
|
||||
)
|
||||
def test_get_or_create_weather_account(fresh_db):
|
||||
weather_account = get_or_create_weather_account()
|
||||
|
||||
assert weather_account.name == DEFAULT_DATA_SOURCE_NAME
|
||||
assert (
|
||||
modeling.Account.query.filter(
|
||||
modeling.Account.name == weather_account.name
|
||||
).count()
|
||||
== 1
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
not FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Account-linked weather sources are only supported on FlexMeasures >= 0.32.",
|
||||
)
|
||||
def test_get_or_create_owm_data_source_registers_weather_source_on_weather_account(
|
||||
fresh_db,
|
||||
):
|
||||
data_source = get_or_create_owm_data_source()
|
||||
|
||||
assert data_source.type == SOURCE_TYPE
|
||||
assert data_source.account is not None
|
||||
assert data_source.account.name == data_source.name
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
not FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Account-linked weather sources are only supported on FlexMeasures >= 0.32.",
|
||||
)
|
||||
def test_get_or_create_owm_data_source_for_derived_data_uses_weather_account(fresh_db):
|
||||
derived_data_source = get_or_create_owm_data_source_for_derived_data()
|
||||
|
||||
assert derived_data_source.type == SOURCE_TYPE
|
||||
assert derived_data_source.account is not None
|
||||
assert derived_data_source.account.name == DEFAULT_DATA_SOURCE_NAME
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
not FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Account-linked weather sources are only supported on FlexMeasures >= 0.32.",
|
||||
)
|
||||
def test_get_or_create_owm_data_source_passes_weather_account_when_supported(
|
||||
fresh_db, monkeypatch
|
||||
):
|
||||
captured_kwargs = {}
|
||||
|
||||
def fake_get_or_create_source(source, source_type, account, flush):
|
||||
captured_kwargs.update(
|
||||
dict(
|
||||
source=source,
|
||||
source_type=source_type,
|
||||
account=account,
|
||||
flush=flush,
|
||||
)
|
||||
)
|
||||
return SimpleNamespace(type=source_type, account=account)
|
||||
|
||||
monkeypatch.setattr(
|
||||
"flexmeasures_weather.utils.modeling.get_or_create_source",
|
||||
fake_get_or_create_source,
|
||||
)
|
||||
|
||||
data_source = get_or_create_owm_data_source()
|
||||
|
||||
assert data_source.type == SOURCE_TYPE
|
||||
assert captured_kwargs["account"].name == DEFAULT_DATA_SOURCE_NAME
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
not FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Account-linked weather sources are only supported on FlexMeasures >= 0.32.",
|
||||
)
|
||||
def test_get_or_create_owm_derived_data_source_passes_weather_account_when_supported(
|
||||
fresh_db, monkeypatch
|
||||
):
|
||||
captured_kwargs = {}
|
||||
|
||||
def fake_get_or_create_source(source, source_type, account, flush):
|
||||
captured_kwargs.update(
|
||||
dict(
|
||||
source=source,
|
||||
source_type=source_type,
|
||||
account=account,
|
||||
flush=flush,
|
||||
)
|
||||
)
|
||||
return SimpleNamespace(type=source_type, account=account)
|
||||
|
||||
monkeypatch.setattr(
|
||||
"flexmeasures_weather.utils.modeling.get_or_create_source",
|
||||
fake_get_or_create_source,
|
||||
)
|
||||
|
||||
data_source = get_or_create_owm_data_source_for_derived_data()
|
||||
|
||||
assert data_source.type == SOURCE_TYPE
|
||||
assert captured_kwargs["account"].name == DEFAULT_DATA_SOURCE_NAME
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Legacy source creation without accounts is only used on FlexMeasures < 0.32.",
|
||||
)
|
||||
def test_get_or_create_owm_data_source_omits_account_when_not_supported(monkeypatch):
|
||||
captured_kwargs = {}
|
||||
|
||||
def fake_get_or_create_source(source, source_type, flush):
|
||||
captured_kwargs.update(
|
||||
dict(
|
||||
source=source,
|
||||
source_type=source_type,
|
||||
flush=flush,
|
||||
)
|
||||
)
|
||||
return SimpleNamespace(type=source_type, name=source)
|
||||
|
||||
monkeypatch.setattr(
|
||||
"flexmeasures_weather.utils.modeling.get_or_create_source",
|
||||
fake_get_or_create_source,
|
||||
)
|
||||
|
||||
data_source = get_or_create_owm_data_source()
|
||||
|
||||
assert data_source.type == SOURCE_TYPE
|
||||
assert captured_kwargs == {
|
||||
"source": DEFAULT_DATA_SOURCE_NAME,
|
||||
"source_type": SOURCE_TYPE,
|
||||
"flush": False,
|
||||
}
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
FM_SUPPORTS_ACCOUNT_LINKED_SOURCES,
|
||||
reason="Legacy source creation without accounts is only used on FlexMeasures < 0.32.",
|
||||
)
|
||||
def test_get_or_create_owm_derived_data_source_omits_account_when_not_supported(
|
||||
monkeypatch,
|
||||
):
|
||||
captured_kwargs = {}
|
||||
|
||||
def fake_get_or_create_source(source, source_type, flush):
|
||||
captured_kwargs.update(
|
||||
dict(
|
||||
source=source,
|
||||
source_type=source_type,
|
||||
flush=flush,
|
||||
)
|
||||
)
|
||||
return SimpleNamespace(type=source_type, name=source)
|
||||
|
||||
monkeypatch.setattr(
|
||||
"flexmeasures_weather.utils.modeling.get_or_create_source",
|
||||
fake_get_or_create_source,
|
||||
)
|
||||
|
||||
data_source = get_or_create_owm_data_source_for_derived_data()
|
||||
|
||||
assert data_source.type == SOURCE_TYPE
|
||||
assert captured_kwargs == {
|
||||
"source": f"FlexMeasures {DEFAULT_DATA_SOURCE_NAME}",
|
||||
"source_type": SOURCE_TYPE,
|
||||
"flush": False,
|
||||
}
|
||||
357
tools/flexmeasures-weather/flexmeasures_weather/utils/weather.py
Normal file
357
tools/flexmeasures-weather/flexmeasures_weather/utils/weather.py
Normal file
@@ -0,0 +1,357 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Tuple, List, Dict, Optional, Any
|
||||
import os
|
||||
from datetime import datetime, timedelta
|
||||
import json
|
||||
|
||||
import click
|
||||
from flask import current_app
|
||||
import requests
|
||||
from humanize import naturaldelta
|
||||
from timely_beliefs import BeliefsDataFrame
|
||||
from flexmeasures.utils.time_utils import as_server_time, get_timezone, server_now
|
||||
from flexmeasures.data.models.time_series import Sensor, TimedBelief
|
||||
from flexmeasures.data.utils import save_to_db
|
||||
|
||||
from flexmeasures_weather import DEFAULT_MAXIMAL_DEGREE_LOCATION_DISTANCE
|
||||
from .locating import find_weather_sensor_by_location
|
||||
from ..sensor_specs import mapping
|
||||
from .modeling import (
|
||||
get_or_create_owm_data_source,
|
||||
get_or_create_owm_data_source_for_derived_data,
|
||||
)
|
||||
from .radiating import compute_irradiance
|
||||
from zoneinfo import ZoneInfo
|
||||
|
||||
API_VERSION = "3.0"
|
||||
|
||||
|
||||
def get_supported_sensor_spec(name: str) -> Optional[dict]:
|
||||
"""
|
||||
Find the specs from a sensor by name.
|
||||
"""
|
||||
for supported_sensor_spec in mapping:
|
||||
if supported_sensor_spec["fm_sensor_name"] == name:
|
||||
return supported_sensor_spec.copy()
|
||||
return None
|
||||
|
||||
|
||||
def get_supported_sensors_str() -> str:
|
||||
"""A string - list of supported sensors, also revealing their unit"""
|
||||
return ", ".join(
|
||||
[
|
||||
f"{sensor_specs['fm_sensor_name']} ({sensor_specs['unit']})"
|
||||
for sensor_specs in mapping
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def process_weatherapi_data(
|
||||
data: List[Dict[str, Any]], hour_no: int
|
||||
) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Processes raw WeatherAPI forecast data into a format similar to OpenWeatherMap's format.
|
||||
|
||||
Args:
|
||||
data (List[Dict[str, Any]]): A list of forecast day dictionaries from WeatherAPI,
|
||||
each containing an 'hour' key with 24 hourly entries.
|
||||
hour_no (int): The index of the current hour to start from.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: A list of 48 hourly forecast entries, each mapped to the
|
||||
expected structure with fields like temperature, humidity, wind, and condition.
|
||||
"""
|
||||
first_day = data[0]["hour"]
|
||||
second_day = data[1]["hour"]
|
||||
third_day = data[2]["hour"]
|
||||
combined = first_day + second_day + third_day
|
||||
|
||||
relevant = combined[hour_no : hour_no + 48]
|
||||
return relevant
|
||||
|
||||
|
||||
def call_openweatherapi(
|
||||
api_key: str, location: Tuple[float, float]
|
||||
) -> Tuple[datetime, List[Dict]]:
|
||||
"""
|
||||
Make a single "one-call" to the Open Weather API and return the API timestamp as well as the 48 hourly forecasts.
|
||||
See https://openweathermap.org/api/one-call-3 for docs.
|
||||
Note that the first forecast is about the current hour.
|
||||
"""
|
||||
check_openweathermap_version(API_VERSION)
|
||||
query_str = f"lat={location[0]}&lon={location[1]}&units=metric&exclude=minutely,daily,alerts&appid={api_key}"
|
||||
res = requests.get(
|
||||
f"http://api.openweathermap.org/data/{API_VERSION}/onecall?{query_str}"
|
||||
)
|
||||
assert (
|
||||
res.status_code == 200
|
||||
), f"OpenWeatherMap returned status code {res.status_code}: {res.text}"
|
||||
data = res.json()
|
||||
time_of_api_call = as_server_time(
|
||||
datetime.fromtimestamp(data["current"]["dt"], tz=get_timezone())
|
||||
).replace(second=0, microsecond=0)
|
||||
return time_of_api_call, data["hourly"]
|
||||
|
||||
|
||||
def call_weatherapi(
|
||||
api_key: str, location: Tuple[float, float], days: int = 3
|
||||
) -> Tuple[datetime, List[Dict]]:
|
||||
"""
|
||||
Makes a request to the WeatherAPI to retrieve hourly weather forecast data.
|
||||
|
||||
Args:
|
||||
api_key (str): API key for authenticating with the Weather API.
|
||||
location (Tuple[float, float]): A tuple containing the latitude and longitude.
|
||||
days (int, optional): Number of days to request the forecast for (default is 3, including current day).
|
||||
|
||||
Returns:
|
||||
Tuple[datetime, List[Dict]]:
|
||||
- The timestamp of the API call.
|
||||
- A list of hourly forecast data as dictionaries. Note that the first forecast is about the current hour.
|
||||
|
||||
Raises:
|
||||
AssertionError: If the response from the Weather API is not successful (HTTP status 200).
|
||||
"""
|
||||
|
||||
latitude, longitude = location[0], location[1]
|
||||
|
||||
query_str = f"http://api.weatherapi.com/v1/forecast.json?key={api_key}&q={latitude},{longitude}&days={days}&aqi=yes&alerts=yes"
|
||||
res = requests.get(query_str)
|
||||
|
||||
assert (
|
||||
res.status_code == 200
|
||||
), f"Weather API returned status code {res.status_code}: {res.text}"
|
||||
|
||||
data = res.json()
|
||||
|
||||
# get the time of the api call
|
||||
time_of_call = int(data["location"]["localtime_epoch"])
|
||||
local_timezone = ZoneInfo(data["location"]["tz_id"])
|
||||
local_time = datetime.fromtimestamp(time_of_call, local_timezone)
|
||||
time_of_api_call = as_server_time(local_time)
|
||||
time_of_api_call = time_of_api_call.replace(second=0, microsecond=0)
|
||||
|
||||
print(f"Time of API call in WAPI is {time_of_api_call}")
|
||||
|
||||
relevant = data["forecast"]["forecastday"]
|
||||
hour_no = local_time.hour
|
||||
|
||||
hourly = process_weatherapi_data(relevant, hour_no)
|
||||
return time_of_api_call, hourly
|
||||
|
||||
|
||||
def call_api(
|
||||
api_key: str, location: Tuple[float, float]
|
||||
) -> Tuple[datetime, List[Dict]]:
|
||||
"""
|
||||
Dispatches the weather API call based on the configured provider.
|
||||
|
||||
Args:
|
||||
api_key (str): API key for the selected weather service provider.
|
||||
location (Tuple[float, float]): Latitude and longitude tuple.
|
||||
|
||||
Returns:
|
||||
Tuple[datetime, List[Dict]]:
|
||||
- Timestamp of the API call.
|
||||
- List of hourly forecast data.
|
||||
|
||||
Raises:
|
||||
Exception: If an invalid weather provider is configured.
|
||||
"""
|
||||
|
||||
provider = str(current_app.config.get("WEATHER_PROVIDER", "OWM"))
|
||||
if provider not in ["OWM", "WAPI"]:
|
||||
raise Exception(
|
||||
"Invalid provider name. Please set WEATHER_PROVIDER setting in config file to either OWM or WAPI, the two permissible options."
|
||||
)
|
||||
|
||||
if provider == "OWM":
|
||||
click.secho("Calling Open Weather Map")
|
||||
return call_openweatherapi(api_key, location)
|
||||
else:
|
||||
click.secho("Calling Weather API")
|
||||
return call_weatherapi(api_key, location)
|
||||
|
||||
|
||||
def save_forecasts_in_db( # noqa: C901
|
||||
api_key: str,
|
||||
locations: List[Tuple[float, float]],
|
||||
):
|
||||
"""Process the response from Weather Provider API into timed beliefs.
|
||||
Collects all forecasts for all locations and all sensors at all locations, then bulk-saves them.
|
||||
"""
|
||||
click.echo("[FLEXMEASURES-WEATHER] Getting weather forecasts:")
|
||||
click.echo("[FLEXMEASURES-WEATHER] Latitude, Longitude")
|
||||
click.echo("[FLEXMEASURES-WEATHER] -----------------------")
|
||||
max_degree_difference_for_nearest_weather_sensor = current_app.config.get(
|
||||
"WEATHER_MAXIMAL_DEGREE_LOCATION_DISTANCE",
|
||||
DEFAULT_MAXIMAL_DEGREE_LOCATION_DISTANCE,
|
||||
)
|
||||
provider = str(current_app.config.get("WEATHER_PROVIDER", ""))
|
||||
if provider not in ["OWM", "WAPI"]:
|
||||
raise Exception(
|
||||
"Invalid provider name. Please set WEATHER_PROVIDER setting in config file to either OWM or WAPI, the two permissible options."
|
||||
)
|
||||
for location in locations:
|
||||
click.echo("[FLEXMEASURES] %s, %s" % location)
|
||||
weather_sensors: Dict[str, Sensor] = (
|
||||
{}
|
||||
) # keep track of the sensors to save lookups
|
||||
db_forecasts: Dict[Sensor, List[TimedBelief]] = {} # collect beliefs per sensor
|
||||
|
||||
now = server_now()
|
||||
time_of_api_call, forecasts = call_api(api_key, location)
|
||||
diff_fm_owm = now - time_of_api_call
|
||||
if abs(diff_fm_owm) > timedelta(minutes=10):
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] Warning: difference between this server and Weather Provider is {naturaldelta(diff_fm_owm)}"
|
||||
)
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] Called weather provider {provider} API successfully at {now}."
|
||||
)
|
||||
|
||||
# loop through forecasts, including the one of current hour (horizon 0)
|
||||
for fc in forecasts:
|
||||
time_key = fc["dt"] if provider == "OWM" else fc["time_epoch"]
|
||||
fc_datetime = as_server_time(
|
||||
datetime.fromtimestamp(time_key, get_timezone())
|
||||
)
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] Processing forecast for {fc_datetime} ..."
|
||||
)
|
||||
data_source = get_or_create_owm_data_source()
|
||||
for sensor_specs in mapping:
|
||||
sensor_name = str(sensor_specs["fm_sensor_name"])
|
||||
provider_response_label = sensor_specs[f"{provider}_sensor_name"]
|
||||
if provider_response_label in fc:
|
||||
weather_sensor = get_weather_sensor(
|
||||
sensor_specs,
|
||||
location,
|
||||
weather_sensors,
|
||||
max_degree_difference_for_nearest_weather_sensor,
|
||||
)
|
||||
if weather_sensor is not None:
|
||||
click.echo(
|
||||
f"Found pre-configured weather sensor {weather_sensor.name} ..."
|
||||
)
|
||||
if weather_sensor not in db_forecasts.keys():
|
||||
db_forecasts[weather_sensor] = []
|
||||
|
||||
fc_value = fc[provider_response_label]
|
||||
|
||||
if provider_response_label == "wind_kph":
|
||||
# convert wind speed from kph to m/s
|
||||
fc_value = fc[provider_response_label] / 3.6
|
||||
|
||||
# the irradiance is not available in Provider -> we compute it ourselves
|
||||
if sensor_name == "irradiance":
|
||||
fc_value = compute_irradiance(
|
||||
location[0],
|
||||
location[1],
|
||||
fc_datetime,
|
||||
# Provider sends cloud cover in percent, we need a ratio
|
||||
fc_value / 100.0,
|
||||
)
|
||||
data_source = (
|
||||
get_or_create_owm_data_source_for_derived_data()
|
||||
)
|
||||
|
||||
db_forecasts[weather_sensor].append(
|
||||
TimedBelief(
|
||||
event_start=fc_datetime,
|
||||
belief_time=now,
|
||||
event_value=fc_value,
|
||||
sensor=weather_sensor,
|
||||
source=data_source,
|
||||
)
|
||||
)
|
||||
else:
|
||||
# we will not fail here, but issue a warning
|
||||
msg = "No label '%s' in response data for time %s" % (
|
||||
provider_response_label,
|
||||
fc_datetime,
|
||||
)
|
||||
click.echo("[FLEXMEASURES-WEATHER] %s" % msg)
|
||||
current_app.logger.warning(msg)
|
||||
for sensor in db_forecasts.keys():
|
||||
click.echo(f"[FLEXMEASURES-WEATHER] Saving {sensor.name} forecasts ...")
|
||||
if len(db_forecasts[sensor]) == 0:
|
||||
# This is probably a serious problem
|
||||
raise Exception(
|
||||
"Nothing to put in the database was produced. That does not seem right..."
|
||||
)
|
||||
status = save_to_db(BeliefsDataFrame(db_forecasts[sensor]))
|
||||
if status == "success_but_nothing_new":
|
||||
current_app.logger.info(
|
||||
"[FLEXMEASURES-WEATHER] Done. These beliefs had already been saved before."
|
||||
)
|
||||
elif status == "success_with_unchanged_beliefs_skipped":
|
||||
current_app.logger.info(
|
||||
"[FLEXMEASURES-WEATHER] Done. Some beliefs had already been saved before."
|
||||
)
|
||||
|
||||
|
||||
def get_weather_sensor(
|
||||
sensor_specs: dict,
|
||||
location: Tuple[float, float],
|
||||
weather_sensors: Dict[str, Sensor],
|
||||
max_degree_difference_for_nearest_weather_sensor: int,
|
||||
) -> Sensor | None:
|
||||
"""Get the weather sensor for this own response label and location, if we haven't retrieved it already."""
|
||||
sensor_name = str(sensor_specs["fm_sensor_name"])
|
||||
if sensor_name in weather_sensors:
|
||||
weather_sensor = weather_sensors[sensor_name]
|
||||
else:
|
||||
weather_sensor = find_weather_sensor_by_location(
|
||||
location,
|
||||
max_degree_difference_for_nearest_weather_sensor,
|
||||
sensor_name=sensor_name,
|
||||
)
|
||||
weather_sensors[sensor_name] = weather_sensor
|
||||
if (
|
||||
weather_sensor is not None
|
||||
and weather_sensor.event_resolution != sensor_specs["event_resolution"]
|
||||
):
|
||||
raise Exception(
|
||||
f"[FLEXMEASURES-WEATHER] The weather sensor found for {sensor_name} has an unfitting event resolution (should be {sensor_specs['event_resolution']}, but is {weather_sensor.event_resolution}."
|
||||
)
|
||||
return weather_sensor
|
||||
|
||||
|
||||
def save_forecasts_as_json(
|
||||
api_key: str, locations: List[Tuple[float, float]], data_path: str
|
||||
):
|
||||
"""Get forecasts, then store each as a raw JSON file, for later processing."""
|
||||
click.echo("[FLEXMEASURES-WEATHER] Getting weather forecasts:")
|
||||
click.echo("[FLEXMEASURES-WEATHER] Latitude, Longitude")
|
||||
click.echo("[FLEXMEASURES-WEATHER] ----------------------")
|
||||
for location in locations:
|
||||
click.echo("[FLEXMEASURES-WEATHER] %s, %s" % location)
|
||||
now = server_now()
|
||||
time_of_api_call, forecasts = call_api(api_key, location)
|
||||
diff_fm_owm = now - time_of_api_call
|
||||
if abs(diff_fm_owm) > timedelta(minutes=10):
|
||||
click.echo(
|
||||
f"[FLEXMEASURES-WEATHER] Warning: difference between this server and Weather Provider is {naturaldelta(diff_fm_owm)}"
|
||||
)
|
||||
now_str = now.strftime("%Y-%m-%dT%H-%M-%S")
|
||||
path_to_files = os.path.join(data_path, now_str)
|
||||
if not os.path.exists(path_to_files):
|
||||
click.echo(f"[FLEXMEASURES-WEATHER] Making directory: {path_to_files} ...")
|
||||
os.mkdir(path_to_files)
|
||||
forecasts_file = "%s/forecast_lat_%s_lng_%s.json" % (
|
||||
path_to_files,
|
||||
str(location[0]),
|
||||
str(location[1]),
|
||||
)
|
||||
with open(forecasts_file, "w") as outfile:
|
||||
json.dump(forecasts, outfile)
|
||||
|
||||
|
||||
def check_openweathermap_version(api_version: str):
|
||||
supported_versions = ["2.5", "3.0"]
|
||||
if api_version not in supported_versions:
|
||||
current_app.logger.warning(
|
||||
f"This plugin may not be fully compatible with OpenWeatherMap API version {api_version}. We tested with versions {supported_versions}"
|
||||
)
|
||||
21
tools/flexmeasures-weather/requirements/Readme.md
Normal file
21
tools/flexmeasures-weather/requirements/Readme.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Requirements
|
||||
|
||||
All requirements for flexmeasures-flexmeasures-weather are specified in this directory.
|
||||
We separate by use case:
|
||||
|
||||
- app: All requirements for running the plugin
|
||||
- test: Additional requirements used for running automated tests
|
||||
- dev: Additional requirements used for developers (this includes testing)
|
||||
|
||||
Also note the following distinction:
|
||||
|
||||
|
||||
## .in files
|
||||
|
||||
Here, we describe the requirements. We give the name of a requirement or even a range (e.g. `>=1.0.`).
|
||||
|
||||
## .txt files
|
||||
|
||||
These files are not to be edited by hand. They are created by `pip-compile` (or `make freeze-deps`).
|
||||
|
||||
Each requirement is pinned to a specific version in these files. The great benefit is reproducibility across environments (local dev as well as staging or production).
|
||||
6
tools/flexmeasures-weather/requirements/app.in
Normal file
6
tools/flexmeasures-weather/requirements/app.in
Normal file
@@ -0,0 +1,6 @@
|
||||
flexmeasures
|
||||
pvlib
|
||||
# the following three are optional in pvlib, but we use them
|
||||
netCDF4
|
||||
siphon
|
||||
tables
|
||||
444
tools/flexmeasures-weather/requirements/app.txt
Normal file
444
tools/flexmeasures-weather/requirements/app.txt
Normal file
@@ -0,0 +1,444 @@
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.10
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile --output-file=requirements/app.txt requirements/app.in
|
||||
#
|
||||
alembic==1.16.1
|
||||
# via flask-migrate
|
||||
altair==5.5.0
|
||||
# via flexmeasures
|
||||
argon2-cffi==23.1.0
|
||||
# via flexmeasures
|
||||
argon2-cffi-bindings==21.2.0
|
||||
# via argon2-cffi
|
||||
arrow==1.3.0
|
||||
# via rq-dashboard
|
||||
async-timeout==5.0.1
|
||||
# via redis
|
||||
attrs==25.3.0
|
||||
# via
|
||||
# jsonschema
|
||||
# referencing
|
||||
babel==2.17.0
|
||||
# via py-moneyed
|
||||
bcrypt==4.0.1
|
||||
# via flexmeasures
|
||||
beautifulsoup4==4.13.4
|
||||
# via siphon
|
||||
blinker==1.9.0
|
||||
# via
|
||||
# flask
|
||||
# flask-mail
|
||||
# flask-principal
|
||||
# sentry-sdk
|
||||
blosc2==3.3.4
|
||||
# via tables
|
||||
certifi==2025.4.26
|
||||
# via
|
||||
# netcdf4
|
||||
# requests
|
||||
# sentry-sdk
|
||||
cffi==1.17.1
|
||||
# via argon2-cffi-bindings
|
||||
cftime==1.6.4.post1
|
||||
# via netcdf4
|
||||
charset-normalizer==3.4.2
|
||||
# via requests
|
||||
click==8.2.1
|
||||
# via
|
||||
# click-default-group
|
||||
# flask
|
||||
# flexmeasures
|
||||
# rq
|
||||
click-default-group==1.2.4
|
||||
# via flexmeasures
|
||||
contourpy==1.3.2
|
||||
# via matplotlib
|
||||
convertdate==2.4.0
|
||||
# via workalendar
|
||||
cycler==0.12.1
|
||||
# via matplotlib
|
||||
dill==0.4.0
|
||||
# via openturns
|
||||
dnspython==2.7.0
|
||||
# via email-validator
|
||||
email-validator==2.2.0
|
||||
# via
|
||||
# flask-security-too
|
||||
# flexmeasures
|
||||
filelock==3.18.0
|
||||
# via tldextract
|
||||
flask==3.1.1
|
||||
# via
|
||||
# flask-classful
|
||||
# flask-cors
|
||||
# flask-json
|
||||
# flask-login
|
||||
# flask-mail
|
||||
# flask-marshmallow
|
||||
# flask-migrate
|
||||
# flask-principal
|
||||
# flask-security-too
|
||||
# flask-sqlalchemy
|
||||
# flask-sslify
|
||||
# flask-wtf
|
||||
# flexmeasures
|
||||
# rq-dashboard
|
||||
# sentry-sdk
|
||||
flask-classful==0.16.0
|
||||
# via flexmeasures
|
||||
flask-cors==6.0.0
|
||||
# via flexmeasures
|
||||
flask-json==0.4.0
|
||||
# via flexmeasures
|
||||
flask-login==0.6.3
|
||||
# via
|
||||
# flask-security-too
|
||||
# flexmeasures
|
||||
flask-mail==0.10.0
|
||||
# via flexmeasures
|
||||
flask-marshmallow==1.3.0
|
||||
# via flexmeasures
|
||||
flask-migrate==4.1.0
|
||||
# via flexmeasures
|
||||
flask-principal==0.4.0
|
||||
# via flask-security-too
|
||||
flask-security-too==5.6.2
|
||||
# via flexmeasures
|
||||
flask-sqlalchemy==3.1.1
|
||||
# via
|
||||
# flask-migrate
|
||||
# flexmeasures
|
||||
flask-sslify==0.1.5
|
||||
# via flexmeasures
|
||||
flask-wtf==1.2.2
|
||||
# via
|
||||
# flask-security-too
|
||||
# flexmeasures
|
||||
flexcache==0.3
|
||||
# via pint
|
||||
flexmeasures==0.25.0
|
||||
# via -r requirements/app.in
|
||||
flexparser==0.4
|
||||
# via pint
|
||||
fonttools==4.58.1
|
||||
# via matplotlib
|
||||
greenlet==3.2.2
|
||||
# via sqlalchemy
|
||||
h5py==3.13.0
|
||||
# via pvlib
|
||||
humanize==4.12.3
|
||||
# via flexmeasures
|
||||
idna==3.10
|
||||
# via
|
||||
# email-validator
|
||||
# requests
|
||||
# tldextract
|
||||
importlib-metadata==8.7.0
|
||||
# via
|
||||
# flexmeasures
|
||||
# timely-beliefs
|
||||
importlib-resources==6.5.2
|
||||
# via flask-security-too
|
||||
inflect==6.0.2
|
||||
# via flexmeasures
|
||||
inflection==0.5.1
|
||||
# via flexmeasures
|
||||
iso8601==2.1.0
|
||||
# via flexmeasures
|
||||
isodate==0.7.2
|
||||
# via
|
||||
# flexmeasures
|
||||
# timely-beliefs
|
||||
itsdangerous==2.2.0
|
||||
# via
|
||||
# flask
|
||||
# flask-wtf
|
||||
jinja2==3.1.6
|
||||
# via
|
||||
# altair
|
||||
# flask
|
||||
joblib==1.4.2
|
||||
# via
|
||||
# scikit-learn
|
||||
# sktime
|
||||
jsonschema==4.24.0
|
||||
# via altair
|
||||
jsonschema-specifications==2025.4.1
|
||||
# via jsonschema
|
||||
kiwisolver==1.4.8
|
||||
# via matplotlib
|
||||
lunardate==0.2.2
|
||||
# via workalendar
|
||||
mako==1.3.10
|
||||
# via alembic
|
||||
markupsafe==3.0.2
|
||||
# via
|
||||
# flask
|
||||
# flask-security-too
|
||||
# jinja2
|
||||
# mako
|
||||
# sentry-sdk
|
||||
# werkzeug
|
||||
# wtforms
|
||||
marshmallow==3.26.1
|
||||
# via
|
||||
# -r requirements/app.in
|
||||
# flask-marshmallow
|
||||
# flexmeasures
|
||||
# marshmallow-polyfield
|
||||
# marshmallow-sqlalchemy
|
||||
# webargs
|
||||
marshmallow-polyfield==5.11
|
||||
# via flexmeasures
|
||||
marshmallow-sqlalchemy==1.4.2
|
||||
# via flexmeasures
|
||||
matplotlib==3.10.3
|
||||
# via timetomodel
|
||||
msgpack==1.1.0
|
||||
# via blosc2
|
||||
narwhals==1.41.0
|
||||
# via altair
|
||||
ndindex==1.10.0
|
||||
# via blosc2
|
||||
netcdf4==1.7.2
|
||||
# via -r requirements/app.in
|
||||
numexpr==2.10.2
|
||||
# via
|
||||
# blosc2
|
||||
# tables
|
||||
numpy==1.26.4
|
||||
# via
|
||||
# blosc2
|
||||
# cftime
|
||||
# contourpy
|
||||
# h5py
|
||||
# matplotlib
|
||||
# netcdf4
|
||||
# numexpr
|
||||
# pandas
|
||||
# patsy
|
||||
# properscoring
|
||||
# pvlib
|
||||
# scikit-learn
|
||||
# scipy
|
||||
# siphon
|
||||
# sktime
|
||||
# statsmodels
|
||||
# tables
|
||||
# timely-beliefs
|
||||
# timetomodel
|
||||
# uniplot
|
||||
openturns==1.24
|
||||
# via timely-beliefs
|
||||
packaging==25.0
|
||||
# via
|
||||
# altair
|
||||
# marshmallow
|
||||
# matplotlib
|
||||
# sktime
|
||||
# statsmodels
|
||||
# tables
|
||||
# webargs
|
||||
pandas==2.2.1
|
||||
# via
|
||||
# flexmeasures
|
||||
# pvlib
|
||||
# siphon
|
||||
# sktime
|
||||
# statsmodels
|
||||
# timely-beliefs
|
||||
# timetomodel
|
||||
passlib==1.7.4
|
||||
# via flask-security-too
|
||||
patsy==1.0.1
|
||||
# via statsmodels
|
||||
pillow==11.2.1
|
||||
# via
|
||||
# flexmeasures
|
||||
# matplotlib
|
||||
pint==0.24.4
|
||||
# via flexmeasures
|
||||
platformdirs==4.3.8
|
||||
# via
|
||||
# blosc2
|
||||
# pint
|
||||
ply==3.11
|
||||
# via pyomo
|
||||
properscoring==0.1
|
||||
# via timely-beliefs
|
||||
protobuf==6.31.1
|
||||
# via siphon
|
||||
psutil==7.0.0
|
||||
# via openturns
|
||||
psycopg2-binary==2.9.10
|
||||
# via
|
||||
# flexmeasures
|
||||
# timely-beliefs
|
||||
pvlib==0.12.0
|
||||
# via -r requirements/app.in
|
||||
py-cpuinfo==9.0.0
|
||||
# via
|
||||
# blosc2
|
||||
# tables
|
||||
py-moneyed==3.0
|
||||
# via flexmeasures
|
||||
pycparser==2.22
|
||||
# via cffi
|
||||
pydantic==1.10.22
|
||||
# via
|
||||
# flexmeasures
|
||||
# inflect
|
||||
pyluach==2.2.0
|
||||
# via workalendar
|
||||
pymeeus==0.5.12
|
||||
# via convertdate
|
||||
pyomo==6.9.2
|
||||
# via flexmeasures
|
||||
pyparsing==3.2.3
|
||||
# via matplotlib
|
||||
python-dateutil==2.9.0.post0
|
||||
# via
|
||||
# arrow
|
||||
# matplotlib
|
||||
# pandas
|
||||
# timetomodel
|
||||
# workalendar
|
||||
python-dotenv==1.1.0
|
||||
# via flexmeasures
|
||||
pytz==2025.2
|
||||
# via
|
||||
# flexmeasures
|
||||
# pandas
|
||||
# pvlib
|
||||
# timely-beliefs
|
||||
# timetomodel
|
||||
pyyaml==6.0.2
|
||||
# via flexmeasures
|
||||
redis==6.2.0
|
||||
# via
|
||||
# flexmeasures
|
||||
# redis-sentinel-url
|
||||
# rq
|
||||
# rq-dashboard
|
||||
redis-sentinel-url==1.0.1
|
||||
# via rq-dashboard
|
||||
referencing==0.36.2
|
||||
# via
|
||||
# jsonschema
|
||||
# jsonschema-specifications
|
||||
requests==2.32.3
|
||||
# via
|
||||
# blosc2
|
||||
# pvlib
|
||||
# requests-file
|
||||
# siphon
|
||||
# tldextract
|
||||
requests-file==2.1.0
|
||||
# via tldextract
|
||||
rpds-py==0.25.1
|
||||
# via
|
||||
# jsonschema
|
||||
# referencing
|
||||
rq==2.3.3
|
||||
# via
|
||||
# flexmeasures
|
||||
# rq-dashboard
|
||||
rq-dashboard==0.8.2.2
|
||||
# via flexmeasures
|
||||
scikit-base==0.12.3
|
||||
# via sktime
|
||||
scikit-learn==1.6.1
|
||||
# via
|
||||
# sktime
|
||||
# timetomodel
|
||||
scipy==1.15.3
|
||||
# via
|
||||
# properscoring
|
||||
# pvlib
|
||||
# scikit-learn
|
||||
# sktime
|
||||
# statsmodels
|
||||
# timely-beliefs
|
||||
# timetomodel
|
||||
sentry-sdk[flask]==2.29.1
|
||||
# via flexmeasures
|
||||
siphon==0.10.0
|
||||
# via -r requirements/app.in
|
||||
six==1.17.0
|
||||
# via python-dateutil
|
||||
sktime==0.37.0
|
||||
# via timely-beliefs
|
||||
soupsieve==2.7
|
||||
# via beautifulsoup4
|
||||
sqlalchemy==2.0.41
|
||||
# via
|
||||
# alembic
|
||||
# flask-sqlalchemy
|
||||
# flexmeasures
|
||||
# marshmallow-sqlalchemy
|
||||
# timely-beliefs
|
||||
# timetomodel
|
||||
statsmodels==0.14.4
|
||||
# via timetomodel
|
||||
tables==3.10.1
|
||||
# via -r requirements/app.in
|
||||
tabulate==0.9.0
|
||||
# via flexmeasures
|
||||
threadpoolctl==3.6.0
|
||||
# via scikit-learn
|
||||
timely-beliefs[forecast]==3.2.0
|
||||
# via flexmeasures
|
||||
timetomodel==0.7.3
|
||||
# via flexmeasures
|
||||
tldextract==5.3.0
|
||||
# via flexmeasures
|
||||
tomli==2.2.1
|
||||
# via alembic
|
||||
types-python-dateutil==2.9.0.20250516
|
||||
# via arrow
|
||||
typing-extensions==4.13.2
|
||||
# via
|
||||
# alembic
|
||||
# altair
|
||||
# beautifulsoup4
|
||||
# flexcache
|
||||
# flexparser
|
||||
# pint
|
||||
# py-moneyed
|
||||
# pydantic
|
||||
# referencing
|
||||
# sqlalchemy
|
||||
# tables
|
||||
tzdata==2025.2
|
||||
# via pandas
|
||||
uniplot==0.21.1
|
||||
# via flexmeasures
|
||||
urllib3==2.4.0
|
||||
# via
|
||||
# requests
|
||||
# sentry-sdk
|
||||
vl-convert-python==1.8.0
|
||||
# via flexmeasures
|
||||
webargs==8.7.0
|
||||
# via flexmeasures
|
||||
werkzeug==3.1.3
|
||||
# via
|
||||
# flask
|
||||
# flask-cors
|
||||
# flask-login
|
||||
# flexmeasures
|
||||
workalendar==17.0.0
|
||||
# via flexmeasures
|
||||
wtforms==3.2.1
|
||||
# via
|
||||
# flask-security-too
|
||||
# flask-wtf
|
||||
xlrd==2.0.1
|
||||
# via flexmeasures
|
||||
zipp==3.22.0
|
||||
# via importlib-metadata
|
||||
|
||||
# The following packages are considered to be unsafe in a requirements file:
|
||||
# setuptools
|
||||
11
tools/flexmeasures-weather/requirements/dev.in
Normal file
11
tools/flexmeasures-weather/requirements/dev.in
Normal file
@@ -0,0 +1,11 @@
|
||||
-c app.txt
|
||||
-c test.txt
|
||||
|
||||
pre-commit
|
||||
black
|
||||
flake8
|
||||
flake8-blind-except
|
||||
mypy
|
||||
pytest-runner
|
||||
setuptools_scm
|
||||
watchdog
|
||||
86
tools/flexmeasures-weather/requirements/dev.txt
Normal file
86
tools/flexmeasures-weather/requirements/dev.txt
Normal file
@@ -0,0 +1,86 @@
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.10
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile --output-file=requirements/dev.txt requirements/dev.in
|
||||
#
|
||||
black==25.1.0
|
||||
# via -r requirements/dev.in
|
||||
cfgv==3.4.0
|
||||
# via pre-commit
|
||||
click==8.2.1
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/test.txt
|
||||
# black
|
||||
distlib==0.3.9
|
||||
# via virtualenv
|
||||
filelock==3.18.0
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# virtualenv
|
||||
flake8==7.2.0
|
||||
# via -r requirements/dev.in
|
||||
flake8-blind-except==0.2.1
|
||||
# via -r requirements/dev.in
|
||||
identify==2.6.12
|
||||
# via pre-commit
|
||||
mccabe==0.7.0
|
||||
# via flake8
|
||||
mypy==1.16.0
|
||||
# via -r requirements/dev.in
|
||||
mypy-extensions==1.1.0
|
||||
# via
|
||||
# black
|
||||
# mypy
|
||||
nodeenv==1.9.1
|
||||
# via pre-commit
|
||||
packaging==25.0
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/test.txt
|
||||
# black
|
||||
# setuptools-scm
|
||||
pathspec==0.12.1
|
||||
# via
|
||||
# black
|
||||
# mypy
|
||||
platformdirs==4.3.8
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# black
|
||||
# virtualenv
|
||||
pre-commit==4.2.0
|
||||
# via -r requirements/dev.in
|
||||
pycodestyle==2.13.0
|
||||
# via flake8
|
||||
pyflakes==3.3.2
|
||||
# via flake8
|
||||
pytest-runner==6.0.1
|
||||
# via -r requirements/dev.in
|
||||
pyyaml==6.0.2
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# pre-commit
|
||||
setuptools-scm==8.3.1
|
||||
# via -r requirements/dev.in
|
||||
tomli==2.2.1
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/test.txt
|
||||
# black
|
||||
# mypy
|
||||
# setuptools-scm
|
||||
typing-extensions==4.13.2
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/test.txt
|
||||
# black
|
||||
# mypy
|
||||
virtualenv==20.31.2
|
||||
# via pre-commit
|
||||
watchdog==6.0.0
|
||||
# via -r requirements/dev.in
|
||||
|
||||
# The following packages are considered to be unsafe in a requirements file:
|
||||
# setuptools
|
||||
10
tools/flexmeasures-weather/requirements/test.in
Normal file
10
tools/flexmeasures-weather/requirements/test.in
Normal file
@@ -0,0 +1,10 @@
|
||||
-c app.txt
|
||||
|
||||
pytest
|
||||
pytest-flask
|
||||
pytest-sugar
|
||||
pytest-cov
|
||||
# lets tests run successfully in containers
|
||||
fakeredis
|
||||
# required with fakeredis, maybe because we use rq
|
||||
lupa
|
||||
88
tools/flexmeasures-weather/requirements/test.txt
Normal file
88
tools/flexmeasures-weather/requirements/test.txt
Normal file
@@ -0,0 +1,88 @@
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.10
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile --output-file=requirements/test.txt requirements/test.in
|
||||
#
|
||||
async-timeout==5.0.1
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# redis
|
||||
blinker==1.9.0
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# flask
|
||||
click==8.2.1
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# flask
|
||||
coverage[toml]==7.8.2
|
||||
# via pytest-cov
|
||||
exceptiongroup==1.3.0
|
||||
# via pytest
|
||||
fakeredis==2.29.0
|
||||
# via -r requirements/test.in
|
||||
flask==3.1.1
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# pytest-flask
|
||||
iniconfig==2.1.0
|
||||
# via pytest
|
||||
itsdangerous==2.2.0
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# flask
|
||||
jinja2==3.1.6
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# flask
|
||||
lupa==2.4
|
||||
# via -r requirements/test.in
|
||||
markupsafe==3.0.2
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# flask
|
||||
# jinja2
|
||||
# werkzeug
|
||||
packaging==25.0
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# pytest
|
||||
# pytest-sugar
|
||||
pluggy==1.6.0
|
||||
# via pytest
|
||||
pytest==8.3.5
|
||||
# via
|
||||
# -r requirements/test.in
|
||||
# pytest-cov
|
||||
# pytest-flask
|
||||
# pytest-sugar
|
||||
pytest-cov==6.1.1
|
||||
# via -r requirements/test.in
|
||||
pytest-flask==1.3.0
|
||||
# via -r requirements/test.in
|
||||
pytest-sugar==1.0.0
|
||||
# via -r requirements/test.in
|
||||
redis==6.2.0
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# fakeredis
|
||||
sortedcontainers==2.4.0
|
||||
# via fakeredis
|
||||
termcolor==3.1.0
|
||||
# via pytest-sugar
|
||||
tomli==2.2.1
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# coverage
|
||||
# pytest
|
||||
typing-extensions==4.13.2
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# exceptiongroup
|
||||
# fakeredis
|
||||
werkzeug==3.1.3
|
||||
# via
|
||||
# -c /home/nicolas/workspace/seita/flexmeasures-weather/requirements/app.txt
|
||||
# flask
|
||||
# pytest-flask
|
||||
6
tools/flexmeasures-weather/run_mypy.sh
Executable file
6
tools/flexmeasures-weather/run_mypy.sh
Executable file
@@ -0,0 +1,6 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
pip install --upgrade mypy > 1.4
|
||||
pip install types-pytz types-requests types-Flask types-click types-redis types-tzlocal types-python-dateutil types-setuptools
|
||||
files=$(find flexmeasures_weather -name \*.py)
|
||||
mypy --follow-imports skip --ignore-missing-imports $files
|
||||
@@ -0,0 +1,2 @@
|
||||
CREATE EXTENSION IF NOT EXISTS cube;
|
||||
CREATE EXTENSION IF NOT EXISTS earthdistance;
|
||||
177
tools/flexmeasures-weather/scripts/solartest.py
Executable file
177
tools/flexmeasures-weather/scripts/solartest.py
Executable file
@@ -0,0 +1,177 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
"""
|
||||
Quick script to compare clear-sky irradiance computations
|
||||
from three different libraries.
|
||||
Among other considerations, this helped us to settle on pvlib.
|
||||
"""
|
||||
from typing import List, Dict
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
import solarpy
|
||||
import pvlib
|
||||
import pysolar
|
||||
import matplotlib.dates as mpl_dates
|
||||
import matplotlib.pyplot as plt
|
||||
import pytz
|
||||
from pandas import DatetimeIndex
|
||||
from tzwhere import tzwhere
|
||||
from astral import LocationInfo
|
||||
from astral.sun import sun
|
||||
|
||||
|
||||
DAY = datetime(2021, 2, 10, tzinfo=pytz.utc)
|
||||
tzwhere = tzwhere.tzwhere()
|
||||
|
||||
locations = {
|
||||
"Amsterdam": (52.370216, 4.895168),
|
||||
"Tokyo": (35.6684415, 139.6007844),
|
||||
"Dallas": (32.779167, -96.808891),
|
||||
"Cape-Town": (-33.943707, 18.588740), # check southern hemisphere, too
|
||||
}
|
||||
datetimes = [DAY + timedelta(minutes=i * 20) for i in range(24 * 3)]
|
||||
timezones = {k: tzwhere.tzNameAt(*v) for k, v in locations.items()}
|
||||
|
||||
|
||||
def irradiance_by_solarpy(
|
||||
latitude: float, longitude: float, dt: datetime, z: str, metric: str = "dni"
|
||||
) -> float:
|
||||
"""Supports direct horizontal irradiance and direct normal irradiance."""
|
||||
h = 0 # sea-level
|
||||
dt = dt.astimezone(pytz.timezone(z)).replace(tzinfo=None) # local time
|
||||
dt = solarpy.standard2solar_time(dt, longitude) # solar time
|
||||
if metric == "dhi": # direct horizontal irradiance
|
||||
vnorm = [0, 0, -1] # plane pointing up
|
||||
elif metric == "dni": # direct normal irradiance
|
||||
vnorm = solarpy.solar_vector_ned(
|
||||
dt, latitude
|
||||
) # plane pointing directly to the sun
|
||||
vnorm[-1] = vnorm[-1] * 0.99999 # avoid floating point error
|
||||
else:
|
||||
return NotImplemented
|
||||
return solarpy.irradiance_on_plane(vnorm, h, dt, latitude)
|
||||
|
||||
|
||||
def irradiance_by_pysolar(
|
||||
latitude: float, longitude: float, dt: datetime, method: str = "dni"
|
||||
) -> float:
|
||||
"""Supports direct normal irradiance."""
|
||||
altitude_deg = pysolar.solar.get_altitude(latitude, longitude, dt)
|
||||
if method == "dni":
|
||||
return pysolar.radiation.get_radiation_direct(dt, altitude_deg)
|
||||
else:
|
||||
return NotImplemented
|
||||
|
||||
|
||||
def irradiance_by_pvlib(
|
||||
latitude: float, longitude: float, dt: datetime, method: str = "dni"
|
||||
) -> float:
|
||||
"""
|
||||
Supports direct horizontal irradiance, direct normal irradiance and global horizontal irradiance.
|
||||
https://firstgreenconsulting.wordpress.com/2012/04/26/differentiate-between-the-dni-dhi-and-ghi/
|
||||
"""
|
||||
site = pvlib.location.Location(latitude, longitude, tz=pytz.utc)
|
||||
solpos = site.get_solarposition(DatetimeIndex([dt]))
|
||||
irradiance = site.get_clearsky(DatetimeIndex([dt]), solar_position=solpos).loc[dt]
|
||||
if method in ("ghi", "dni", "dhi"):
|
||||
return irradiance[method]
|
||||
else:
|
||||
return NotImplemented
|
||||
|
||||
|
||||
def plot_irradiance(
|
||||
city: str,
|
||||
datetimes: List[datetime],
|
||||
values: Dict[str, List[float]],
|
||||
sun_times: Dict[str, datetime],
|
||||
):
|
||||
|
||||
fig, ax = plt.subplots()
|
||||
|
||||
ax.set(
|
||||
xlabel="Time (20m)",
|
||||
ylabel="Direct Normal Irradiance (W/m²)",
|
||||
title=f"Irradiance for {city} on {DAY.date()}",
|
||||
)
|
||||
|
||||
# draw values
|
||||
date_ticks = mpl_dates.date2num(datetimes)
|
||||
for lib in ("pysolar", "solarpy", "pvlib"):
|
||||
plt.plot_date(date_ticks, values[lib], "-", label=lib)
|
||||
|
||||
# make date ticks look okay
|
||||
plt.gca().xaxis.set_major_locator(mpl_dates.HourLocator())
|
||||
plt.setp(plt.gca().xaxis.get_majorticklabels(), "rotation", 40)
|
||||
|
||||
# draw day phases boxes
|
||||
dawn_tick, sunrise_tick, noon_tick, sunset_tick, dusk_tick = mpl_dates.date2num(
|
||||
(
|
||||
sun_times["dawn"],
|
||||
sun_times["sunrise"],
|
||||
sun_times["noon"],
|
||||
sun_times["sunset"],
|
||||
sun_times["dusk"],
|
||||
)
|
||||
)
|
||||
dawn_to_sunrise = plt.Rectangle(
|
||||
(dawn_tick, -100),
|
||||
sunrise_tick - dawn_tick,
|
||||
1100,
|
||||
fc="floralwhite",
|
||||
ec="lemonchiffon",
|
||||
label="Dawn to Sunrise",
|
||||
)
|
||||
plt.gca().add_patch(dawn_to_sunrise)
|
||||
|
||||
sunrise_to_sunset = plt.Rectangle(
|
||||
(sunrise_tick, -100),
|
||||
sunset_tick - sunrise_tick,
|
||||
1100,
|
||||
fc="lightyellow",
|
||||
ec="lemonchiffon",
|
||||
label="Sunrise to sunset",
|
||||
)
|
||||
plt.gca().add_patch(sunrise_to_sunset)
|
||||
|
||||
sunset_to_dusk = plt.Rectangle(
|
||||
(sunset_tick, -100),
|
||||
dusk_tick - sunset_tick,
|
||||
1100,
|
||||
fc="oldlace",
|
||||
ec="lemonchiffon",
|
||||
label="Sunset to dusk",
|
||||
)
|
||||
plt.gca().add_patch(sunset_to_dusk)
|
||||
|
||||
# draw noon
|
||||
plt.axvline(x=noon_tick, color="gold", label="Noon")
|
||||
|
||||
plt.legend()
|
||||
|
||||
fig.savefig(f"test-irradiance-{city}.png")
|
||||
plt.show()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
for city in locations:
|
||||
values = dict(pysolar=[], solarpy=[], pvlib=[])
|
||||
lat, lon = locations[city]
|
||||
timezone = timezones[city]
|
||||
loc_info = LocationInfo(timezone=timezone, latitude=lat, longitude=lon)
|
||||
# this gives 'dawn', 'sunrise', 'noon', 'sunset' and 'dusk'
|
||||
sun_times = sun(loc_info.observer, date=DAY.date(), tzinfo=loc_info.timezone)
|
||||
local_datetimes = [
|
||||
dt.replace(tzinfo=pytz.timezone(timezones[city])) for dt in datetimes
|
||||
]
|
||||
|
||||
for dt in local_datetimes:
|
||||
irrad_pysolar = irradiance_by_pysolar(lat, lon, dt)
|
||||
values["pysolar"].append(irrad_pysolar)
|
||||
irrad_solarpy = irradiance_by_solarpy(lat, lon, dt, timezone)
|
||||
values["solarpy"].append(irrad_solarpy)
|
||||
irrad_pvlib = irradiance_by_pvlib(lat, lon, dt)
|
||||
values["pvlib"].append(irrad_pvlib)
|
||||
print(
|
||||
f"For {city} at {dt} {timezones[city]} ― pysolar: {irrad_pysolar:.2f}, solarpy: {irrad_solarpy:.2f}, pvlib: {irrad_pvlib:.2f}"
|
||||
)
|
||||
plot_irradiance(city, local_datetimes, values, sun_times)
|
||||
11
tools/flexmeasures-weather/setup.cfg
Normal file
11
tools/flexmeasures-weather/setup.cfg
Normal file
@@ -0,0 +1,11 @@
|
||||
[aliases]
|
||||
test = pytest
|
||||
flake8 = flake8
|
||||
|
||||
[flake8]
|
||||
exclude = .git,__pycache__,documentation
|
||||
max-line-length = 160
|
||||
max-complexity = 13
|
||||
select = B,C,E,F,W,B9
|
||||
ignore = E501, W503, E203
|
||||
|
||||
47
tools/flexmeasures-weather/setup.py
Normal file
47
tools/flexmeasures-weather/setup.py
Normal file
@@ -0,0 +1,47 @@
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
|
||||
def load_requirements(use_case):
|
||||
"""
|
||||
Loading range requirements.
|
||||
Packaging should be used for installing the package into existing stacks.
|
||||
We therefore read the .in file for the use case.
|
||||
.txt files include the exact pins, and are useful for deployments with
|
||||
exactly comparable environments.
|
||||
"""
|
||||
reqs = []
|
||||
with open("requirements/%s.in" % use_case, "r") as f:
|
||||
reqs = [
|
||||
req
|
||||
for req in f.read().splitlines()
|
||||
if not req.strip() == ""
|
||||
and not req.strip().startswith("#")
|
||||
and not req.strip().startswith("-c")
|
||||
and not req.strip().startswith("--find-links")
|
||||
]
|
||||
return reqs
|
||||
|
||||
|
||||
setup(
|
||||
name="flexmeasures-weather",
|
||||
description="Integrating FlexMeasures with multiple API services",
|
||||
author="Seita Energy Flexibility BV",
|
||||
author_email="nicolas@seita.nl",
|
||||
url="https://github.com/FlexMeasures/flexmeasures-weather",
|
||||
keywords=["flexmeasures", "energy flexibility"],
|
||||
install_requires=load_requirements("app"),
|
||||
tests_require=load_requirements("test"),
|
||||
setup_requires=["pytest-runner", "setuptools_scm"],
|
||||
use_scm_version={"local_scheme": "no-local-version"}, # handled by setuptools_scm
|
||||
packages=find_packages(),
|
||||
include_package_data=True, # setuptools_scm takes care of adding the files in SCM
|
||||
classifiers=[
|
||||
"Programming Language :: Python",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Development Status :: 3 - Alpha",
|
||||
"License :: OSI Approved :: Apache Software License",
|
||||
"Operating System :: OS Independent",
|
||||
],
|
||||
long_description="""\
|
||||
""",
|
||||
)
|
||||
Reference in New Issue
Block a user