Wetterturnier Wordpress Plugin

This is the documentation for the wetterturnier.de wordpress plugin (wp-wetterturnier) providing full wordpress integration. Please note that the plugin is not yet ready-to-go (installation procedure has to be tested and fixed), the known issues section has some more details.

What is “Wetterturnier”

The “Berliner Wetterturnier” as it has been known as in the beginning was launched in the year 2000 at the Institute of Meteorology at the FU Berlin. Since 2005 five cities in Central Europe are included.

Wetterturnier is a platform where hobby meteorologists, experts and statistical forecast model developer battle against each other. The goal is to predict a set of meteorological variables, such as sunshine duration, wind speed, or temperature as good as possible for the consecutive two days.

This plugin is the frontend core of the whole system providing full wordpress integration (user management, messaging services, forums) and the platform where our users can submit their forecasts/bets. Furthermore this plugin provides live ranking tables, a leader-board, a data archive, and access to a set of important data sets such as observations and forecast maps.

Screenshot Frontend

Please note that this is only one part of the system. To get the whole system running the Wetterturnier backend is needed which prepares the observations, computes mean bets for specific groups, and computes the points for the ranking system. For more information please visit the documentation on readthedocs <http://wetterturnier-wordpress-plugin.readthedocs.io/en/latest/overview.html>_.

Documentation

The documentation for this repository can be found on readthedocs. An overview of the full wetterturnier system (which this plugin is the frontend core) can be found under documentation > overview.

If there are any questions please do not hesitate to contact one of our contributers trough github or via the Wetterturnier.de Website.

License Information

The software in this repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The full LICENSE file is included in the repository and/or can be found on gnu.org.

Code of Conduct

We care about oterhs, their attitude, and their ideology wherefore we follow the [Contributor Covenant][codhomepage] code of conduct. The full code of conduct is included in the repository. If you wanna share ideas and/or contribute to this repository please follow these rules.

[cochomepage]: http://contributor-covenant.org [cocversion]: http://contributor-covenant.org/version/1/4/

Software Dependencies

The plugin is based on wordpress and has been tested using the following software: Wordpress 4.9 with php 7.0 and mysql 5.1.73. For some very specific applications d3 v4 is used.

Software Overview

Important blocks

Known Issues

First I have to mention that I’ve tried to program the plugin as generic as possible, but as this is a very specific application some parts might be narrowing everything a bit down. However, with some people willing to contribute we might lift this plugin to the next level!

This is an incomplete list of important known open points which might be adressed over the next months, or might not.

Note

  • Sphinx phpautodoc (v 1.2.1 by Takeshi Komiya does not yet extract @param, @return and other settings from the docs.
  • Plugin installation procedure is prepared, but outdated and not yet tested! Plugin updating procedure/uninstall not yet considered. This makes an installation hard or even impossible, has to be adressed a.s.a.p.. If you’d like to test/use the plugin you might contact the author to ask for the table template at the moment.
  • The wetterturnier plugin is designed to forecast the two consecutive days. While parts are ready to decrease/increase this number, others are not (e.g., the database design is not able to do so).
  • Currently only deterministic forecasts (e.g., 10 degrees celsius for tomorrow noon) are possible. Would be quite a bit of effort but cool to also allow for probabilistic forecasts/scorings (more state of the art for meteo community)

Classes and Libraries

Databases and Tables

  • Database Tables: Contains database table structure and information on the use of the table.

Full Todo List from The Whole Documentation

Full list of all (often duplicated) todos found in the whole documentation.

Todo

Description missing.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/admin.rst, line 69.)

Todo

Experimental, not yet documented.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/admin.rst, line 223.)

Todo

Documentation missing.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/admin.rst, line 230.)

Todo

Provide detailed table description here and what to find where and why and who fills in/deletes the data sets.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/dbtables.rst, line 185.)

Todo

How should I document all the single files … maybe worth to combine them (list/template/view)? Even if wordpress says that should be fine?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/files.rst, line 5.)

Todo

Here I would like to tell a bit about how to set up the frontend and which plugins we are currently using side by side with the wp-wetterturnier plugin to the the full functionality. However, at the moment the setup routine for the wordpress plugin is not in its final and tested stage, so this is something for later.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/gettingstarted.rst, line 18.)

Todo

Move repository from bitbucket -> github, add link, and add few more details here.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/gettingstarted.rst, line 85.)

Todo

Currently uses the method userclass::show_leading. Should be decoupled and rather use the new (not yet scripted) rankingclass and procude the output directly within WP_wetterturnier_widget_leading::show_leading.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/thewidgets.rst, line 48.)

Todo

Provide some brief information about the data set and where these routines are running and/or can be found on the wetterturnier server (cross-ref style).

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/thewidgets.rst, line 77.)

Todo

Provide some brief information about the data set and where these routines are running and/or can be found on the wetterturnier server (cross-ref style).

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/thewidgets.rst, line 105.)

Todo

Check whether it would make sense to move the data request into the new and not yet coded rankingclass.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/thewidgets.rst, line 134.)

Todo

Check whether it would make sense to move the data request into the new and not yet coded rankingclass.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/wetterturnier-wordpress-plugin/checkouts/stable/docs/thewidgets.rst, line 159.)