frequenz-api-weather


Namefrequenz-api-weather JSON
Version 0.3.0 PyPI version JSON
download
home_page
SummaryFrequenz gRPC API for retrieving weather forecasts.
upload_time2024-03-01 15:49:22
maintainer
docs_urlNone
author
requires_python<4,>=3.11
licenseMIT
keywords frequenz python api grpc protobuf rpc weather
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Frequenz Weather API

[![Build Status](https://github.com/frequenz-floss/frequenz-api-weather/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-api-weather/actions/workflows/ci.yaml)
[![PyPI Package](https://img.shields.io/pypi/v/frequenz-api-weather)](https://pypi.org/project/frequenz-api-weather/)
[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-api-weather/)

## Overview
This Weather Forecast API provides access to weather forecast data. The forecast 
data includes features such as wind components and solar radiation levels at
specified geographic coordinates. The forecasting process involves predicting
atmospheric conditions based on various factors and models. The data provided by
this API represents the forecasted state of the atmosphere at different heights
above the ground and for various forecast creation times. 

## Objective
The primary objective of this API is to provide real-time and historical weather
forecast data to enable more efficient
energy management, trading, and planning within microgrids and larger gridpool
portfolios.

## Key Features
- Real-time Weather Forecasting: Access current atmospheric conditions based on
 recent data.
- Historical Data Access: Retrieve past weather forecasts for analysis and trend
 prediction.
- Feature Customization: Choose from a variety of weather features like wind speed,
 solar radiation, and more.
- Geographical Flexibility: Get forecasts for any location specified by latitude and
 longitude.

## Example Use Cases
- Adjusting the trading of photovoltaic (PV) surplus production based on future
 solar radiation forecasts.
- Feeding excess energy into batteries when low consumption or high production is
 forecasted.
- Dynamic pricing strategies for energy trading based on anticipated weather
 conditions.
- Resource allocation in microgrids for anticipated energy demands, guided by
 weather forecasts.
- Risk assessment and contingency planning for severe weather events.

## Target Audience
This API is designed for application developers in the energy sector who focus on
the tasks of optimizing microgrid electricity flows or trading of energy. Its design
aims to be as developer-friendly as possible, requiring no prior knowledge in
electrical engineering and systems and/or weather forecast services. 

## Contributing

If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "frequenz-api-weather",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<4,>=3.11",
    "maintainer_email": "",
    "keywords": "frequenz,python,api,grpc,protobuf,rpc,weather",
    "author": "",
    "author_email": "Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>",
    "download_url": "https://files.pythonhosted.org/packages/ce/d1/84a844b3346d593f59bcfd6361ff3e2e3504fb898c45b9992ee6e9182c07/frequenz-api-weather-0.3.0.tar.gz",
    "platform": null,
    "description": "# Frequenz Weather API\n\n[![Build Status](https://github.com/frequenz-floss/frequenz-api-weather/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-api-weather/actions/workflows/ci.yaml)\n[![PyPI Package](https://img.shields.io/pypi/v/frequenz-api-weather)](https://pypi.org/project/frequenz-api-weather/)\n[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-api-weather/)\n\n## Overview\nThis Weather Forecast API provides access to weather forecast data. The forecast \ndata includes features such as wind components and solar radiation levels at\nspecified geographic coordinates. The forecasting process involves predicting\natmospheric conditions based on various factors and models. The data provided by\nthis API represents the forecasted state of the atmosphere at different heights\nabove the ground and for various forecast creation times. \n\n## Objective\nThe primary objective of this API is to provide real-time and historical weather\nforecast data to enable more efficient\nenergy management, trading, and planning within microgrids and larger gridpool\nportfolios.\n\n## Key Features\n- Real-time Weather Forecasting: Access current atmospheric conditions based on\n recent data.\n- Historical Data Access: Retrieve past weather forecasts for analysis and trend\n prediction.\n- Feature Customization: Choose from a variety of weather features like wind speed,\n solar radiation, and more.\n- Geographical Flexibility: Get forecasts for any location specified by latitude and\n longitude.\n\n## Example Use Cases\n- Adjusting the trading of photovoltaic (PV) surplus production based on future\n solar radiation forecasts.\n- Feeding excess energy into batteries when low consumption or high production is\n forecasted.\n- Dynamic pricing strategies for energy trading based on anticipated weather\n conditions.\n- Resource allocation in microgrids for anticipated energy demands, guided by\n weather forecasts.\n- Risk assessment and contingency planning for severe weather events.\n\n## Target Audience\nThis API is designed for application developers in the energy sector who focus on\nthe tasks of optimizing microgrid electricity flows or trading of energy. Its design\naims to be as developer-friendly as possible, requiring no prior knowledge in\nelectrical engineering and systems and/or weather forecast services. \n\n## Contributing\n\nIf you want to know how to build this project and contribute to it, please\ncheck out the [Contributing Guide](CONTRIBUTING.md).\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Frequenz gRPC API for retrieving weather forecasts.",
    "version": "0.3.0",
    "project_urls": {
        "Changelog": "https://github.com/frequenz-floss/frequenz-api-weather/releases",
        "Documentation": "https://frequenz-floss.github.io/frequenz-api-weather/",
        "Issues": "https://github.com/frequenz-floss/frequenz-api-weather/issues",
        "Repository": "https://github.com/frequenz-floss/frequenz-api-weather",
        "Support": "https://github.com/frequenz-floss/frequenz-api-weather/discussions/categories/support"
    },
    "split_keywords": [
        "frequenz",
        "python",
        "api",
        "grpc",
        "protobuf",
        "rpc",
        "weather"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47008bf11b05f1216c795fc22eb7749c082a2b62af664f8471c9ef25e6ac8b36",
                "md5": "b8ff6f039f216954a5f68f0ef874d919",
                "sha256": "577403df57e21372f570689c19f1c44008c636aa1257d39cd8b1c750d68fa6e3"
            },
            "downloads": -1,
            "filename": "frequenz_api_weather-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b8ff6f039f216954a5f68f0ef874d919",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.11",
            "size": 25110,
            "upload_time": "2024-03-01T15:49:20",
            "upload_time_iso_8601": "2024-03-01T15:49:20.906109Z",
            "url": "https://files.pythonhosted.org/packages/47/00/8bf11b05f1216c795fc22eb7749c082a2b62af664f8471c9ef25e6ac8b36/frequenz_api_weather-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ced184a844b3346d593f59bcfd6361ff3e2e3504fb898c45b9992ee6e9182c07",
                "md5": "74a49a6d71b38b95c3035c7c0cb3f110",
                "sha256": "728d0e70203bd9f32e81c78156f6eebd7db99be44a87b77f38d5c63a9baf1945"
            },
            "downloads": -1,
            "filename": "frequenz-api-weather-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "74a49a6d71b38b95c3035c7c0cb3f110",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.11",
            "size": 85430,
            "upload_time": "2024-03-01T15:49:22",
            "upload_time_iso_8601": "2024-03-01T15:49:22.442624Z",
            "url": "https://files.pythonhosted.org/packages/ce/d1/84a844b3346d593f59bcfd6361ff3e2e3504fb898c45b9992ee6e9182c07/frequenz-api-weather-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-01 15:49:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "frequenz-floss",
    "github_project": "frequenz-api-weather",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "frequenz-api-weather"
}
        
Elapsed time: 0.20196s