Contents

Overview

workflow_pytests workflow_checks Documentation Status Requirements Status Coverage Status packaging PyPI Package latest release PyPI Wheel Supported versions Supported implementations Commits since latest release

Connect weather data interfaces with interfaces of wind and pv power models.

  • Free software: MIT license

Installation

pip install feedinlib

You can also install the in-development version with:

pip install https://github.com/oemof/feedinlib/archive/master.zip

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows 
set PYTEST_ADDOPTS=--cov-append
tox
Other 
PYTEST_ADDOPTS=--cov-append tox

The feedinlib is designed to calculate feed-in time series of photovoltaic and wind power plants. It is part of the oemof group but works as a standalone application.

The feedinlib is ready to use but it definitely has a lot of space for further development, new and improved models and nice features.

Introduction

So far the feedinlib provides interfaces to download open_FRED and ERA5 weather data. open_FRED is a local reanalysis weather data set that provides weather data for Germany (and bounding box). ERA5 is a global reanalysis weather data set that provides weather data for the whole world. The weather data can be used to calculate the electrical output of PV and wind power plants. At the moment the feedinlib provides interfaces to the pvlib and the windpowerlib. Furthermore, technical parameters for many PV modules and inverters, as well as wind turbines, are made available and can be easily used for calculations.

Installation

If you have a working Python 3 environment, use pip to install the latest feedinlib version:

pip install feedinlib

The feedinlib is designed for Python 3 and tested on Python >= 3.6.

We highly recommend to use virtual environments.

Examples and basic usage

The basic usage of the feedinlib is shown in the Examples section. The examples are provided as jupyter notebooks that you can download here:

Furthermore, you have to install the feedinlib with additional packages needed to run the notebooks, e.g. jupyter.

pip install feedinlib[examples]

To launch jupyter notebook type jupyter notebook in the terminal. This will open a browser window. Navigate to the directory containing the notebook(s) to open it. See the jupyter notebook quick start guide for more information on how to run jupyter notebooks.

Contributing

We are warmly welcoming all who want to contribute to the feedinlib. If you are interested do not hesitate to contact us via github.

As the feedinlib started with contributors from the oemof developer group we use the same developer rules.

How to create a pull request:

  • Fork the feedinlib repository to your own github account.
  • Create a local clone of your fork and install the cloned repository using pip with -e option:
pip install -e /path/to/the/repository
  • Change, add or remove code.
  • Commit your changes.
  • Create a pull request and describe what you will do and why.
  • Wait for approval.

Generally the following steps are required when changing, adding or removing code:

  • Add new tests if you have written new functions/classes.
  • Add/change the documentation (new feature, API changes …).
  • Add a whatsnew entry and your name to Contributors.
  • Check if all tests still work by simply executing pytest in your feedinlib directory:
pytest

Citing the feedinlib

We use the zenodo project to get a DOI for each version. Search zenodo for the right citation of your feedinlib version.

License

MIT License

Copyright (C) 2017 oemof developer group

Installation

At the command line:

pip install feedinlib

Usage

To use feedinlib in a project:

Examples

API

Power plant classes

Power plant classes for specific weather dependent renewable energy resources.

feedinlib.powerplants.Photovoltaic([model]) Class to define a standard set of PV system attributes.
feedinlib.powerplants.WindPowerPlant([model]) Class to define a standard set of wind power plant attributes.

Feed-in models

Feed-in models take in power plant and weather data to calculate power plant feed-in. So far models using the python libraries pvlib and windpowerlib to calculate photovoltaic and wind power feed-in, respectively, have been implemented.

feedinlib.models.Pvlib(**kwargs) Model to determine the feed-in of a photovoltaic module using the pvlib.
feedinlib.models.WindpowerlibTurbine(**kwargs) Model to determine the feed-in of a wind turbine using the windpowerlib.
feedinlib.models.WindpowerlibTurbineCluster(…) Model to determine the feed-in of a wind turbine cluster using the windpowerlib.

Weather data

The feedinlib enables download of open_FRED weather data (local reanalysis data for Germany) and ERA5 weather data (global reanalysis data for the whole world).

feedinlib.open_FRED.Weather
feedinlib.era5.weather_df_from_era5(…[, …]) Gets ERA5 weather data from netcdf file and converts it to a pandas dataframe as required by the spcified lib.
feedinlib.era5.get_era5_data_from_datespan_and_position(…) Send request for era5 data to the Climate Data Store (CDS)

Tools

feedinlib.models.get_power_plant_data(…) Function to retrieve power plant data sets provided by feed-in models.

Abstract classes

The feedinlib uses abstract classes for power plant and feed-in models that serve as blueprints for classes that implement those models. This ensures that new models provide required implementations that make it possible to easily exchange the model used in your calculation. They are important for people who want to implement new power plant and model classes rather than for users.

feedinlib.powerplants.Base(**attributes) The base class of feedinlib power plants.
feedinlib.models.base.Base(**kwargs) The base class of feedinlib models.
feedinlib.models.base.PhotovoltaicModelBase(…) Expands model base class Base by PV specific attributes.
feedinlib.models.base.WindpowerModelBase(…) Expands model base class Base by wind power specific attributes.

Reference

feedinlib

Parameter Names

feedinlib windpowerlib pvlib
parameter unit parameter unit parameter unit
wind_speed m/s wind_speed m/s wind_speed m/s
air_temperature K temperature K temp_air C
pressure Pa pressure Pa    
roughness_length m roughness_length m    
surface_normalized_global_downwelling_shortwave_flux W/m^2     ghi W/m^2
surface_diffuse_downwelling_shortwave_flux W/m^2     dhi W/m^2
surface_normalized_direct_downwelling_shortwave_flux W/m^2     dni W/m^2

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

feedinlib could always use more documentation, whether as part of the official feedinlib docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/oemof/feedinlib/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up feedinlib for local development:

  1. Fork feedinlib (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:YOURGITHUBNAME/feedinlib.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes run all the checks and docs builder with tox one command:

    tox

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox).
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel:

tox -p auto

Authors

oemof developer group - https://oemof.org

(alphabetic order)

  • Birgit Schachler
  • Cord Kaldemeyer
  • Francesco Witte
  • gplssm
  • Patrik Schönfeldt
  • Pierre Francois
  • Sabine Haas
  • Stephan Günther
  • Stephen Bosch
  • Uwe Krien

Changelog

Changelog

0.0.0 (2021-06-10)

  • First release on PyPI.

These are new features and improvements of note in each release

v0.1.0 ()
New features
Documentation
Testing
Bug fixes
Other changes
Contributors
v0.0.12 (June 22, 2017)
Bug fixes
  • fixed setup.py since feedinlib only works with windpowerlib version 0.0.4
Contributors
  • Birgit Schachler
v0.0.11 (November 22, 2016)
New features
  • Using model of windpowerlib instead of internal model. This will be the future of the feedinlib.
Bug fixes
  • removed ‘vernetzen’-server because it is down
Contributors
  • Uwe Krien
v0.0.10 (November 18, 2016)
Other changes

Move wind power calculations to windpowerlib Allow installation of windpowerlib for python versions >3.4 Import requests package instead of urllib5

Contributors
  • Uwe Krien
  • Stephen Bosch
  • Birgit Schachler
v0.0.9 (August 23, 2016)
Bug fixes
  • Adapt API due to changes in the pvlib
  • Avoid pandas future warning running the pv model
Contributors
  • Uwe Krien
v0.0.8 (Mai 2, 2016)
New features
  • add a geometry attribute for shapely.geometry objects to the weather class
  • add lookup table for the sandia pv modules
Documentation
  • add link to the developer rules of oemof
Bug fixes
  • Adapt url to sandia’s module library
Contributors
  • Uwe Krien
v0.0.7 (October 20, 2015)
New features
  • add a weather class to define the structure of the weather data input
  • add example file to pass your own model class to the feedinlib
Documentation
  • correct some typos
  • some distribtions are clearer now
  • describe the used units
Testing
  • add more doctests
  • removed obsolete tests
Bug fixes
  • does not overwrite class attributes (issue 7)
Other changes
  • rename classes to more describing names
  • initialisation of a power plant changed (see README for details)
Contributors
  • Uwe Krien
  • Stephan Günther
  • Cord Kaldemeyer

Indices and tables