|
|
| (33 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| | | | |
| − | '''Concept of upgrading the openmod online presence to an OpenEnergy Platform'''<br/> | + | '''Concept of expanding the openmod online presence to an OpenEnergy Platform'''<br/> |
| | | | |
| − | <font face="Liberation Sans, sans-serif"><font size="4" style="font-size: 14pt">'''Preliminary note'''</font></font> | + | <br/> |
| | | | |
| − | The concept of the OpenEnergy Platform is under development at the moment. Theses wiki pages are constantly updated and are meant to give an overview of the objectives as well as the current state of the concept and implementation of the different components forming the OpenEnergy Platform.
| + | <br/> |
| | | | |
| − | <span lang="en-GB">This platform has not got a final name, but the working title is </span><span lang="en-GB">OpenEnergy Platform </span><span lang="en-GB">(OEP)</span><span lang="en-GB">. </span><span lang="en-GB">Alternatives are for example:</span><br/>
| |
| | | | |
| − | *openmod platform
| |
| − | *openmod portal
| |
| | | | |
| − | <span style="font-style: normal">Feel free to suggest a</span><span style="font-style: normal">nother</span><span style="font-style: normal">name and vote for</span><span style="font-style: normal">your favourite</span><span style="font-style: normal">s</span><span style="font-style: normal">:</span><br/>
| |
| | | | |
| − | *<span lang="en-GB"><span style="font-style: normal">F</span></span><span lang="en-GB"><span style="font-style: normal">irst round: </span></span><span lang="en-GB"><span style="font-style: normal"></span></span><span lang="en-GB"><span style="font-style: normal"></span></span><span lang="en-GB"><span style="font-style: normal">[http://wecide.org/w/utFJpmoMWnF9PehTz Here]</span></span><span lang="en-GB"><span style="font-style: normal">a</span></span><span lang="en-GB"><span style="font-style: normal">ny name can be added and you can</span></span><span lang="en-GB"><span style="font-style: normal">tick</span></span><span lang="en-GB"><span style="font-style: normal">all names you would be ok with.</span></span><span lang="en-GB"><span style="font-style: normal"></span></span>
| |
| − | *<span lang="en-GB"><span style="font-style: normal">S</span></span><span lang="en-GB"><span style="font-style: normal">econd round: The three names that the most participants can live with</span></span><span lang="en-GB"><span style="font-style: normal">(i.e. with the most votes in first round)</span></span><span lang="en-GB"><span style="font-style: normal">are</span></span><span lang="en-GB"><span style="font-style: normal">part of the final</span></span><span lang="en-GB"><span style="font-style: normal">vote and everybody</span></span><span lang="en-GB"><span style="font-style: normal">will be allowed tick one option</span></span><span lang="en-GB"><span style="font-style: normal">.</span></span>
| |
| | | | |
| − | Many the activities regarding the OpenEnergy Plattform, undertaken by ZNES, RLI, Next Energy and the University of Madgeburg, are currently (08/2015 until 08/2016) part of the project ''open_eGo'', which itself is funded by the German Federal Ministy of Economic Affairs and Energy.
| |
| | | | |
| − | <span lang="en-GB">The project proposal was written before the openmod initiative was established </span><span lang="en-GB">and was promoted by the project partners for the same reasons for which they also participated in the foundation of the openmod initative. Now, the OpenEnergy Platform team wants to avoid double structures and use their resourses to support the openmod initiative.</span> | + | |
| | + | |
| | + | |
| | + | |
| | + | |
| | + | = <font face="Liberation Sans, sans-serif"><font size="4" style="font-size: 14pt">Preliminary note</font></font><br/> = |
| | + | |
| | + | The concept of the OpenEnergy Platform is under development at the moment. Theses wiki pages are constantly updated and are meant to give an overview of the objectives as well as the current state of the concept and implementation of the different components forming the OpenEnergy Platform.<br/> |
| | + | |
| | + | <br/>This platform got the working title OpenEnergy Platform (OEP). Considering the low number of participants in the undertaken decision making process with regard to the naming, we decided to continue with the name, which was used until now. In this way we hope to avoid misunderstandigs. |
| | + | |
| | + | <br/> |
| | + | |
| | + | Many of the activities regarding the OpenEnergy Plattform, undertaken by ZNES, RLI, Next Energy and the University of Madgeburg, are currently (08/2015 until 08/2016) part of the project ''open_eGo'', which itself is funded by the German Federal Ministy of Economic Affairs and Energy. |
| | + | |
| | + | <br/> |
| | + | |
| | + | <span lang="en-GB">The project proposal was written before the openmod initiative was established </span><span lang="en-GB">and was promoted by the project partners for the same reasons for which they also participated in the foundation of the openmod initative. Now, the OpenEnergy Platform team wants to avoid double structures and use their resources to support the openmod initiative.</span> |
| | + | |
| | + | |
| | | | |
| | <span lang="en-GB">During the workshop in London </span><span lang="en-GB">(09/2015) </span><span lang="en-GB">a [https://docs.google.com/document/d/16QY4U-DBXhZVxXnpugVkATDtp4SEMjXTgdnYX4CRKWA/edit?pref=2&pli=1 break-out group] </span><span lang="en-GB">discussed the idea of an OpenEnergy Platform and different aspects. The participants agreed on expanding the existing online presence of the openmod initiative. The collected suggestions were </span><span lang="en-GB">advanced during a [[Discussing an openEnergy Platform|workshop in October 2015 in Berlin]].</span><span lang="en-GB"></span> | | <span lang="en-GB">During the workshop in London </span><span lang="en-GB">(09/2015) </span><span lang="en-GB">a [https://docs.google.com/document/d/16QY4U-DBXhZVxXnpugVkATDtp4SEMjXTgdnYX4CRKWA/edit?pref=2&pli=1 break-out group] </span><span lang="en-GB">discussed the idea of an OpenEnergy Platform and different aspects. The participants agreed on expanding the existing online presence of the openmod initiative. The collected suggestions were </span><span lang="en-GB">advanced during a [[Discussing an openEnergy Platform|workshop in October 2015 in Berlin]].</span><span lang="en-GB"></span> |
| | + | |
| | + | <br/> |
| | | | |
| | Thanks to all, who support the development of our common environment with critical and constructive remarks. In other words, please, feel free to discuss the concept with us.<br/> | | Thanks to all, who support the development of our common environment with critical and constructive remarks. In other words, please, feel free to discuss the concept with us.<br/> |
| Line 26: |
Line 40: |
| | <br/> | | <br/> |
| | | | |
| − | <font face="Liberation Sans, sans-serif"><font size="4" style="font-size: 14pt">'''Objectives of the OpenEnergy Platform (OEP)'''</font></font> | + | |
| | + | = <font face="Liberation Sans, sans-serif"><font size="4" style="font-size: 14pt">Objectives of the OpenEnergy Platform (OEP)</font></font> = |
| | | | |
| | The objectives of the OpenEnergy Platform are defined as follows:<br/> | | The objectives of the OpenEnergy Platform are defined as follows:<br/> |
| Line 39: |
Line 54: |
| | *<span lang="en-GB">offering advice for good collaborative working practice (rules, guidelines, </span><span lang="en-GB">processes</span><span lang="en-GB">and tools) </span><span lang="en-GB">and general / structural support (by providing a well-organised working platform)</span> | | *<span lang="en-GB">offering advice for good collaborative working practice (rules, guidelines, </span><span lang="en-GB">processes</span><span lang="en-GB">and tools) </span><span lang="en-GB">and general / structural support (by providing a well-organised working platform)</span> |
| | | | |
| | + | <br/> |
| | | | |
| − | | + | = <font face="Liberation Sans, sans-serif"><font size="4" style="font-size: 14pt"><span lang="en-GB">U</span><span lang="en-GB">ser</span><span lang="en-GB">s </span><span lang="en-GB"></span><span lang="en-GB">of the OpenEnergy Platform</span></font></font><br/> = |
| − | <font face="Liberation Sans, sans-serif"><font size="4" style="font-size: 14pt">'''<span lang="en-GB">U</span><span lang="en-GB">ser</span><span lang="en-GB">s </span><span lang="en-GB"></span><span lang="en-GB">of the OpenEnergy Platform</span>'''</font></font><br/> | + | |
| | | | |
| | #model developer: A model developer is a person, who works on the design and code of energy system models.<br/> | | #model developer: A model developer is a person, who works on the design and code of energy system models.<br/> |
| | #model user: A model user is person who has downloaded / wants to download a model in order to make calculations with own data input and assumptions (scenarios). A model user might become a model developer in future, because she/he might get interested in understanding, improving and expanding the code.<br/> | | #model user: A model user is person who has downloaded / wants to download a model in order to make calculations with own data input and assumptions (scenarios). A model user might become a model developer in future, because she/he might get interested in understanding, improving and expanding the code.<br/> |
| − | #non-modeller: A non-modeller is a person, who does not intent to make own calculations with an energy system, but is for example interested in data and results obtained with different models and scenarios. This could be e.g. a climate protection manager working for a municipality, a person working for a NGO or … .<br/> | + | #non-modeller: A non-modeller is a person, who does not intent to make own calculations with an energy system, but is for example interested in data and results obtained with different models and scenarios. This could be e.g. a climate protection manager working for a municipality, a person working for a NGO or … . |
| | | | |
| | <br/> | | <br/> |
| | | | |
| − | = Main page<br/> =
| |
| | | | |
| − | ([http://openmod-initiative.org/ http://openmod-initiative.org/])<br/>
| + | = Main page and where it links to<br/> = |
| | | | |
| − | <u>'''Use Case of all users:'''</u><br/>
| + | ([http://openmod-initiative.org/ http://openmod-initiative.org/])<br/> |
| | | | |
| − | When the user comes to the main page, she/he sees the openmod logo, a short definition („We are a grass root initiative of modellers from various universities and research institutes across Europe.“), a welcome statement (, the latest news, a tag cloud) and the overview of the provided content, which can be grouped into the following areas.<br/> | + | When the user comes to the main page, she/he sees the openmod logo, a short definition („We are a grass root initiative of modellers from various universities and research institutes across Europe.“), a welcome statement (, the latest news, a tag cloud), [http://openmod-initiative.org/ “Connect!” information] and the overview of (as well as a link to) the provided content, which can be grouped into the following areas: |
| | | | |
| − | *about openmod (html)<br/> | + | *[http://openmod-initiative.org/manifesto.html about openmod] (html) |
| − | *wiki for collaborative, open source modelling incl. glossary, quality criteria, openmod event documentation, open licences, best practice guide | + | *[[Wiki for collaborative, open source modelling|wiki for collaborative, open source modelling]] incl. glossary, quality criteria, openmod event documentation, open licences, best practice guide |
| − | *documentation and tutorials<br/> | + | *[[Platform documentation and tutorials|platform documentation and tutorials]]<br/> |
| − | *news and calendar<br/> | + | *[[News and calendar|news and calendar]]<br/> |
| − | *fact sheets for models, frameworks and scenarios (wiki or html) | + | *[[Fact sheets for models, frameworks and scenarios|fact sheets for models, frameworks and scenarios]] (wiki or html)<br/> |
| − | *database (PostgreSQL database with CKAN surface and import tool) | + | *[[Database|database]] (PostgreSQL database with CKAN surface and import tool) |
| − | *discussion: Ways of model integration (html)<br/> | + | *[[Discussion: Ways of model integration|discussion: Ways of model integration]] (html)<br/> |
| − | *discussion area for model specific teams (maybe) | + | *[[Discussion area for model specific teams|discussion area for model specific teams]] (maybe) |
| − | *archive of the openmod mailing list (maybe) / subscription of the mailing list | + | *archive of the [[Openmod mailing list|openmod mailing list]] (maybe) / subscription of the mailing list |
| − | *fast information how to get started (“Connect!”)<br/> | + | *[http://openmod-initiative.org/ contact, licence and “Impressum”]<br/> |
| − | *contact, licence and “Impressum”<br/>
| + | |
| | | | |
| | From here the user goes to the different subsections depending on her/his background and reason for coming. | | From here the user goes to the different subsections depending on her/his background and reason for coming. |
| Line 75: |
Line 88: |
| | The proposed idea means an adjustment and extension of the existing openmod website (openmod-initiative.org/), which will become the connector between the different areas of the OpenEnergy Platform like for example the wiki and the database. Therefore, the user should easily get back to this main page by clicking on the openmod logo, no matter on which site she/he is.<br/> | | The proposed idea means an adjustment and extension of the existing openmod website (openmod-initiative.org/), which will become the connector between the different areas of the OpenEnergy Platform like for example the wiki and the database. Therefore, the user should easily get back to this main page by clicking on the openmod logo, no matter on which site she/he is.<br/> |
| | | | |
| − | Dear openmod community, being in the openmod wiki a click on the openmod logo leads to the main page of the wiki. Could this click lead to the main page instead?<br/> | + | ''Dear openmod community, being in the openmod wiki a click on the openmod logo leads to the main page of the wiki. Could this click lead to the main page instead?''<br/> |
| | + | <br/> |
| | + | |
| | + | [[File:OEP concept parts figure.png|center|400pxpx|Parts of the OpenEnergy Platform]]<br/> |
| | + | |
| | + | [[File:OEP concept urls figure.png|center|400pxpx]]<br/> |
| | + | |
| | + | |
| | + | |
| | + | = Log-in = |
| | + | |
| | + | <u>Best case:</u> A user, who wants to edit, add and watch articles, statements or other content (including data) on the OpenEnergy Platform, logs in or if not done before creates an account in order to be able to log in. At the same time a profile is created, which the users use to present themselves and to find contact information. That means the existing openmod wiki accounts will give access to the function of the entire platform. |
| | + | |
| | + | The log-in is possible from every single page of the platform. A users, who indicates that she/he forgot her/his password, will be mailed a link to a password reset website. |
| | + | |
| | + | <u>Current setup / Less-than-perfect solution:</u> A user, who wants to edit, add or watch articles and statements on the OpenEnergy Platform (meaning the openmod wiki), logs in or if not done before creates an account in order to be able to log in. At the same time a profile is created, which the users use to present themselves and and to find contact information. |
| | + | |
| | + | The log-in is possible from every single page of the wiki. A users, who indicates that she/he forgot her/his password, will be mailed a link to a password reset website. |
| | + | |
| | + | For changing and uploading data in the [[Database|database]] (and maybe also for editing model and scenario fact sheets) the user needs another account. The main page allows the user to log into the wiki as well as into the other areas. |
| | + | |
| | + | '''<u>Implementation:</u>''' |
| | + | |
| | + | In order to achieve the best case the Auth-Plugin of the underlying openmod MediaWiki needs to be redefined. The expected challenge is the export of the account data including the encrypted passwords from the database of the openmod wiki and the import into the user management of the database using CKAN. In case of unsolvable problems with the data transfer the implementation of an additional user management for the database using CKAN is considered as the second best solution. |
| | + | |
| | + | ''Dear openmod community, is someone of you interested in supporting the user management unification?''<br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | |
| | + | = Search function for the entire platform / platform components<br/> = |
| | + | |
| | + | The user finds a search field on every page of the OpenEnergy Platform. In the drop down menu the user selects which part of the platform is meant to be scanned, for instance the wiki, the glossary or the database. In order to make the search more efficient, the user searching information can choose a term from a list of keywords, that users of the platform use to organise and classify the content (faceted search). |
| | + | |
| | + | In case of a search inside the database, the user is offered the opportunity to limit the results to a specific geographical area by the means of a map. |
| | + | |
| | + | Depending on the performance of the data search a scan of the entire platform might be offered. It needs to be taken into account, that this goes with a less detailed scan of the database. For this reason a hint will be displayed: “For a more detailed search, please, use the database search.“ |
| | + | |
| | + | '''<u>Implementation:</u>''' |
| | + | |
| | + | The search function is based on CKAN and is adjusted to the requirements of the OpenEnergy Platform. This search is a faceted search, meaning keywords (so called tags) are defined and can be searched. On the one hand this search function can scan the tags and descriptions of the datasets in the database in order to find a certain table. On the other hand also a selected dataset in the database can be scanned in order to find a certain term or value. |
| | + | |
| | + | The search inside of the wiki and the other pages will be integrated into the search function. To do that, the (wiki) pages will be extended by tag fields. In the end the search function can scan the tags as well as the content of the (wiki) pages and present the search results to the user.<br/> |
The concept of the OpenEnergy Platform is under development at the moment. Theses wiki pages are constantly updated and are meant to give an overview of the objectives as well as the current state of the concept and implementation of the different components forming the OpenEnergy Platform.
Many of the activities regarding the OpenEnergy Plattform, undertaken by ZNES, RLI, Next Energy and the University of Madgeburg, are currently (08/2015 until 08/2016) part of the project open_eGo, which itself is funded by the German Federal Ministy of Economic Affairs and Energy.
Thanks to all, who support the development of our common environment with critical and constructive remarks. In other words, please, feel free to discuss the concept with us.
When the user comes to the main page, she/he sees the openmod logo, a short definition („We are a grass root initiative of modellers from various universities and research institutes across Europe.“), a welcome statement (, the latest news, a tag cloud), “Connect!” information and the overview of (as well as a link to) the provided content, which can be grouped into the following areas:
From here the user goes to the different subsections depending on her/his background and reason for coming.
The proposed idea means an adjustment and extension of the existing openmod website (openmod-initiative.org/), which will become the connector between the different areas of the OpenEnergy Platform like for example the wiki and the database. Therefore, the user should easily get back to this main page by clicking on the openmod logo, no matter on which site she/he is.
The log-in is possible from every single page of the platform. A users, who indicates that she/he forgot her/his password, will be mailed a link to a password reset website.
The log-in is possible from every single page of the wiki. A users, who indicates that she/he forgot her/his password, will be mailed a link to a password reset website.
In order to achieve the best case the Auth-Plugin of the underlying openmod MediaWiki needs to be redefined. The expected challenge is the export of the account data including the encrypted passwords from the database of the openmod wiki and the import into the user management of the database using CKAN. In case of unsolvable problems with the data transfer the implementation of an additional user management for the database using CKAN is considered as the second best solution.
The user finds a search field on every page of the OpenEnergy Platform. In the drop down menu the user selects which part of the platform is meant to be scanned, for instance the wiki, the glossary or the database. In order to make the search more efficient, the user searching information can choose a term from a list of keywords, that users of the platform use to organise and classify the content (faceted search).
In case of a search inside the database, the user is offered the opportunity to limit the results to a specific geographical area by the means of a map.
Depending on the performance of the data search a scan of the entire platform might be offered. It needs to be taken into account, that this goes with a less detailed scan of the database. For this reason a hint will be displayed: “For a more detailed search, please, use the database search.“
The search function is based on CKAN and is adjusted to the requirements of the OpenEnergy Platform. This search is a faceted search, meaning keywords (so called tags) are defined and can be searched. On the one hand this search function can scan the tags and descriptions of the datasets in the database in order to find a certain table. On the other hand also a selected dataset in the database can be scanned in order to find a certain term or value.
The search inside of the wiki and the other pages will be integrated into the search function. To do that, the (wiki) pages will be extended by tag fields. In the end the search function can scan the tags as well as the content of the (wiki) pages and present the search results to the user.
