|
|
| (18 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| | + | <div><div>([[,|http://wiki.openmod-initiative.org/]] or [http://platform.openmod-initiative.org/wiki http://platform.openmod-initiative.org/wiki])</div><div></div></div> |
| | + | The wiki provides information as well for non-modellers or newbies in the modelling field as for model developers. The presented information is developed collaboratively (i.e. discussions in the background). |
| | | | |
| − | (http://wiki.openmod-initiative.org/ or http://platform.openmod-initiative.org/wiki)
| + | <br/> |
| | | | |
| − | The wiki provides information as well for non-modellers or newbies in the modelling field as for model developers. The presented information is developed collaboratively (i.e. discussions in the background).
| + | <br/> |
| | + | |
| | + | <br/> |
| | | | |
| | = Glossary = | | = Glossary = |
| | | | |
| − | <u>'''Use Case of all users:'''</u>
| + | [[Category:Glossary|http://wiki.openmod-initiative.org/wiki/Category:Glossary]] |
| | | | |
| − | '''Just having a look''' | + | '''Just having a look'''<br/> |
| | | | |
| − | The user, who visits the glossary just to have a look, finds a list of all terms given in alphabetical order. With a click on the term she/he gets to a wiki page showing the term and its definition as well as, if existing, its sub-terms and other related terms (ontology). | + | The user, who visits the glossary just to have a look, finds the given terms in alphabetical order. With a click on a term she/he gets to a wiki page showing the term and its definition as well as, if existing, its sub-terms and other related terms (ontology). |
| | | | |
| | '''Searching a definition''' | | '''Searching a definition''' |
| | | | |
| − | The wish to clarify the terminology is not limited to beginners and non-modellers, because some terms might be used differently or be vague. A user studying a fact sheet (see here) might come across a term, that can be hardly interpreted. In order to get to know, how a term is used and understood in the openmod community, the user types the term into a search field and selects the glossary search. The search results will list all glossary entries whose titles or explanations match. With a click on one of the search result the user gets to the wiki page of the selected term. | + | The wish to clarify the terminology is not limited to beginners and non-modellers, because some terms might be used differently or be vague. A user studying a [[Fact sheets for models, frameworks and scenarios|fact sheet]] might come across a term, that can be hardly interpreted. In order to get to know, how a term is used and understood in the openmod community, the user types the term into a search field and selects the glossary search. The search results will list all glossary entries whose titles or explanations match. With a click on one of the search results the user gets to the wiki page of the selected term.<br/> |
| | | | |
| | '''Giving and discussing a definition''' | | '''Giving and discussing a definition''' |
| Line 22: |
Line 26: |
| | <u>'''Implementation:'''</u> | | <u>'''Implementation:'''</u> |
| | | | |
| − | The glossary is made up by the wiki pages, which are part of the category called “glossary”. | + | The glossary is made up by the wiki pages, which are part of the category called “glossary” (see also). |
| | | | |
| − | = Quality criteria =
| + | <br/> |
| | | | |
| − | <u>'''Use Case of all users:'''</u> | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | = Quality criteria = |
| | | | |
| − | As a result of an ongoing discussion process (in the openmod wiki or another specified place) the user finds quality criteria for data, assumptions, models, scenarios and open source code in the openmod wiki. For example: | + | As a result of an ongoing discussion process (in the openmod wiki or another specified place) the user finds quality criteria for data, assumptions, models, scenarios and open source code in the openmod wiki. For example:<br/> |
| | | | |
| | *Data: source provided, reliable source, licence given, structure of data (i.e. machine readability etc.), ... | | *Data: source provided, reliable source, licence given, structure of data (i.e. machine readability etc.), ... |
| − | *Models: external validation, active community, up-to-date and good documentation (see also https://docs.google.com/document/d/1Rg6f9iGyVcW7o4SolGi_cstwa66tZiOMVQyzmT1PRsA/edit?pref=2&pli=1), good model presentation (http://wiki.openmod-initiative.org/wiki/Best_practices_for_model_websites) incl. Overview of available extensions https://typo3.org/extensions/repository/ etc. There is a certain overlap with the elements of the model fact sheet, but here the best practice is presented / discussed. | + | *Models: external validation, plausability tests passed, active community, up-to-date and good documentation (see also [https://docs.google.com/document/d/1Rg6f9iGyVcW7o4SolGi_cstwa66tZiOMVQyzmT1PRsA/edit?pref=2&pli=1 here]), [[Best practices for model websites|good model presentation]] incl. giving an [https://typo3.org/extensions/repository/ overview of available extensions] etc. There is a certain overlap with the elements of the model fact sheet, but here the best practice is presented / discussed.<br/> |
| | *Assumptions: .. | | *Assumptions: .. |
| − | *Scenarios: … | + | *Scenarios: …plausability tests passed...,... |
| − | *Open Source Code: additional to the criteria for good models: good code and developer documentation, ... | + | *Open Source Code: additional to the criteria for good models: good code documentation, coding guidelines and developer documentation, ... |
| | | | |
| | Specifications / explanations are also given here. The user can also participate in the discussion process. | | Specifications / explanations are also given here. The user can also participate in the discussion process. |
| Line 42: |
Line 50: |
| | Wiki pages. | | Wiki pages. |
| | | | |
| − | = openmod Activities / Events =
| + | <br/> |
| | | | |
| − | '''<u>Use Case of all users:</u>'''
| + | <br/> |
| | + | |
| | + | = openmod Activities / Events = |
| | | | |
| | As up to now the user finds here the wiki pages for the past and coming events of the openmod initiative with links to the protocols and presentations. | | As up to now the user finds here the wiki pages for the past and coming events of the openmod initiative with links to the protocols and presentations. |
| Line 54: |
Line 64: |
| | Wiki pages as before. | | Wiki pages as before. |
| | | | |
| | + | <br/> |
| | | | |
| | = Open Licences = | | = Open Licences = |
| | | | |
| − | '''<u>Use Case of all users:</u>'''
| + | On [[Choosing a license|this wiki page]] the user finds, as before, information with regard to open source licences, copyrights and copylefts. |
| − | | + | |
| − | On [[Choosing_a_license|this wiki page]] the user finds, as before, information with regard to open source licences, copyrights and copylefts. | + | |
| | | | |
| | <u>'''Implementation:'''</u> | | <u>'''Implementation:'''</u> |
| Line 65: |
Line 74: |
| | Wiki pages as before. | | Wiki pages as before. |
| | | | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | + | |
| | + | <br/> |
| | | | |
| | = Best practice guide for collaborative modelling = | | = Best practice guide for collaborative modelling = |
| | | | |
| − | '''<u>Use Case of model developers:</u>'''
| + | [[Guide for collaborative modelling|Guide for collaborative modelling]] |
| | | | |
| | On these wiki pages the user finds a selection of tools, energy system modellers recommend / use for the collaborative open source model development. Moreover, proven work flows are presented by users for users, for example: | | On these wiki pages the user finds a selection of tools, energy system modellers recommend / use for the collaborative open source model development. Moreover, proven work flows are presented by users for users, for example: |
| Line 75: |
Line 91: |
| | *Usage of issues and labels on GitHubs / issue management | | *Usage of issues and labels on GitHubs / issue management |
| | *(git work flows) | | *(git work flows) |
| | + | *using git for collaborative work on documents and papers (including links to good tutorials like this [https://www.atlassian.com/git/tutorials/ one]) |
| | *(regular) web conferences / chats and their rules (e.g. discussing points on the agenda / problems only based on existing suggestions / solution porposals) | | *(regular) web conferences / chats and their rules (e.g. discussing points on the agenda / problems only based on existing suggestions / solution porposals) |
| | *Good real-life meetings (incl. organising events for the developer community like [http://t3board15.typo3.org/ http://t3board15.typo3.org/]) | | *Good real-life meetings (incl. organising events for the developer community like [http://t3board15.typo3.org/ http://t3board15.typo3.org/]) |
| Line 81: |
Line 98: |
| | *Decision making processes | | *Decision making processes |
| | *Asking the community (mailing list or Question and Answer (Q&A) on Stack Overflow with preferred tag) | | *Asking the community (mailing list or Question and Answer (Q&A) on Stack Overflow with preferred tag) |
| − | *perhaps also presentation of negative examples | + | *perhaps also presentation of what didn't work |
| | | | |
| | <u>'''Implementation:'''</u> | | <u>'''Implementation:'''</u> |
| Line 87: |
Line 104: |
| | Wiki pages. | | Wiki pages. |
| | | | |
| | + | <br/> |
| | | | |
| − | = Coding Rules / Guidelines / Standards =
| + | <br/> |
| | | | |
| − | <u>'''Use Case of model developers:'''</u> | + | <br/> |
| | | | |
| − | The model developers document and discuss their rules / guidelines for the coding of energy system models and their components on these wiki pages in order to establish good practice and perhaps to facilitate the process of model integration (see also [[Discussion:_Ways_of_model_integration|here]]). The model developers might use the annual openmod workshops to collaboratively develop these best practice standards for software design.
| + | = Coding Rules / Guidelines / Standards = |
| | | | |
| − | ''Differentiation between Coding Rules / Guidelines published by oemof (e.g. git braching model) and by the OpenEnergy Platform required!''
| + | The model developers document and discuss their rules / guidelines for the coding of energy system models and their components on these wiki pages in order to establish good practice and perhaps to facilitate the process of model integration (see also [[Discussion: Ways of model integration|here]]). The model developers might use the annual openmod workshops to collaboratively develop these best practice standards for software design. |
| | | | |
| | Examples for modelling with Python could be: | | Examples for modelling with Python could be: |
The wiki provides information as well for non-modellers or newbies in the modelling field as for model developers. The presented information is developed collaboratively (i.e. discussions in the background).
The user, who visits the glossary just to have a look, finds the given terms in alphabetical order. With a click on a term she/he gets to a wiki page showing the term and its definition as well as, if existing, its sub-terms and other related terms (ontology).
The wish to clarify the terminology is not limited to beginners and non-modellers, because some terms might be used differently or be vague. A user studying a fact sheet might come across a term, that can be hardly interpreted. In order to get to know, how a term is used and understood in the openmod community, the user types the term into a search field and selects the glossary search. The search results will list all glossary entries whose titles or explanations match. With a click on one of the search results the user gets to the wiki page of the selected term.
A logged-in user can on the one hand create a new glossary page in the wiki in order to give a definition of a new term. On the other hand she/he can participate in the discussions belonging to existing glossary entries as well as she/he can change the glossary entries themselves.
The glossary is made up by the wiki pages, which are part of the category called “glossary” (see also).
As a result of an ongoing discussion process (in the openmod wiki or another specified place) the user finds quality criteria for data, assumptions, models, scenarios and open source code in the openmod wiki. For example:
Specifications / explanations are also given here. The user can also participate in the discussion process.
As up to now the user finds here the wiki pages for the past and coming events of the openmod initiative with links to the protocols and presentations.
(Hint: The upcoming openmod workshop will also be presented on the main page (“Connect!”).)
On these wiki pages the user finds a selection of tools, energy system modellers recommend / use for the collaborative open source model development. Moreover, proven work flows are presented by users for users, for example:
The model developers document and discuss their rules / guidelines for the coding of energy system models and their components on these wiki pages in order to establish good practice and perhaps to facilitate the process of model integration (see also here). The model developers might use the annual openmod workshops to collaboratively develop these best practice standards for software design.
