Model publication and policies: Difference between revisions

From IAMC-Documentation
Jump to navigation Jump to search
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
== IAMC documentation process flow ==
# Model group requests for participation.
# IAMC Agrees.
# Administrator prepares the wiki.
# Authors enter documentation; process stage is 'ín preparation'.
# Authors indicate to the administrator that they have finished the documentation; process state is 'submitted'.
# The model documentation is reviewed during two months after submission; process stage is 'under review'.
# During the documentation process each page belonging to this model will display a warning saying that the documentation is not yet published. The menus won't give access to the model pages.
# After this period and if the documentation is satisfactory to the IAMC the documentation enters the process stage published.
# Administrator registers the published state
== Models in preparation, submitted or under review ==
== Models in preparation, submitted or under review ==
The models in the table below  are not yet published. The links in this table will take you to the forms page of the reference card or the top page of the model documentation.
The models in the table below  are not yet published. The links in this table will take you to the forms page of the reference card or the top page of the model documentation.


{{#ask:[[Category:Model]][[HasProcessState::!published]]
{{#ask:[[Category:Model]][[HasProcessState::!published]]
Line 14: Line 27:


== Publication policies of IAMC Documentation ==
== Publication policies of IAMC Documentation ==
* IAM models may participate in the IAMC wiki fully documented or with a documented reference card only. In the last case only the last bullet applies.
# IAM models may participate in the IAMC wiki fully documented or with a documented reference card only. In the last case only the second and last bullet applies.
* Each model that wants to participate in the IAMC wiki is subject to the [[#IAMC documentation process flow]]
# Each model that wants to participate in the IAMC wiki is subject to the [[#IAMC documentation process flow]]
* The model documentation is organized in a prescribed [[#documentation tree]]. The model documentation must be ordered according this classification.
# The model documentation is organized in a prescribed [[#documentation tree]]. The model documentation must be ordered according this classification.
* At the start of documenting a model all possible pages are generated. The info box at the right of each model documentation page enables you to navigate through the documentation pages. All 'not optional' pages in the documentation tree must be filled with some appropriate text. If a documentation entry is not applicable to your model, then put a short note, otherwise write here an introduction and more detailed documentation in the underlying level (if any).
# Moving top-down through the documentation tree to the most detailed pages, all the pages on the way should have some text.
* At the end of the documenting process the empty pages should be removed from the documentation tree (via More=>delete or ask the [mailto:Rineke.oostenrijk@pbl.nl administrator])
# At the start of documenting a model all possible pages are generated (REMARK: or just the mandatory pages...) . The info box at the right of each model documentation page enables you to navigate through the documentation pages. All 'not optional' pages in the documentation tree must be filled with some appropriate text. If a documentation entry is not applicable to your model, then put a short note, otherwise write here an introduction and more detailed documentation in the underlying level (if any).
* The reference card summarizes the features of each model. Every model must enter its features into the forms of the reference card. The [[Special:RunQuery/Models-AttributesForm|comparison of the model documentation]] uses this information.
# At the end of the documenting process the empty pages should be removed from the documentation tree (via More=>delete or ask the [mailto:Rineke.oostenrijk@pbl.nl administrator])
# The reference card summarizes the features of each model. Every model must enter its features into the forms of the reference card. The [[Special:RunQuery/Model_Feature_Compare_Form|comparison of the model documentation]] uses this information.


== Documentation tree ==
== Documentation tree ==
Line 36: Line 50:
  |parent=Subcategory of}}
  |parent=Subcategory of}}


== IAMC documentation process flow ==
# Model group requests for participation.
# IAMC Agrees.
# Administrator prepares the wiki.
# Authors enter documentation; process stage is 'ín preparation'.
# Authors indicate to the administrator that they have finished the documentation; process state is 'submitted'.
# The model documentation is reviewed during two months after submission; process stage is 'under review'.
# After this period and if the documentation is satisfactory to the IAMC the documentation enters the process stage published.
# Administrator registers the published state


[[Category:Editor Tool]]
[[Category:Editor Tool]]

Latest revision as of 14:41, 28 April 2020

IAMC documentation process flow

  1. Model group requests for participation.
  2. IAMC Agrees.
  3. Administrator prepares the wiki.
  4. Authors enter documentation; process stage is 'ín preparation'.
  5. Authors indicate to the administrator that they have finished the documentation; process state is 'submitted'.
  6. The model documentation is reviewed during two months after submission; process stage is 'under review'.
  7. During the documentation process each page belonging to this model will display a warning saying that the documentation is not yet published. The menus won't give access to the model pages.
  8. After this period and if the documentation is satisfactory to the IAMC the documentation enters the process stage published.
  9. Administrator registers the published state

Models in preparation, submitted or under review

The models in the table below are not yet published. The links in this table will take you to the forms page of the reference card or the top page of the model documentation.


ModelParticipation modeProcess stageModel documentation (top of doc. tree)input reference card
AIM-Enduse India full in preparation Model Documentation - AIM-Enduse India AIM-Enduse India
AIM-Hub Indonesia reference card only in preparation N/A AIM-Hub Indonesia
COFFEE-TEA full under review Model Documentation - COFFEE-TEA COFFEE-TEA
E3ME-FTT full submitted Model Documentation - E3ME-FTT E3ME-FTT
ENV-Linkages full in preparation Model Documentation - ENV-Linkages ENV-Linkages
ENVISAGE reference card only in preparation N/A ENVISAGE
EPPA full in preparation Model Documentation - EPPA EPPA
GCAM full under review Model Documentation - GCAM GCAM
GCAM-KAIST reference card only in preparation N/A GCAM-KAIST
GMM full in preparation Model Documentation - GMM GMM
GRACE full under review Model Documentation - GRACE GRACE
ICES full in preparation Model Documentation - ICES ICES
IFs full under review Model Documentation - IFs IFs
IMACLIM-India reference card only in preparation N/A IMACLIM-India
IPAC-AIM technology full in preparation Model Documentation - IPAC-AIM technology IPAC-AIM technology
IPAC-Global full in preparation Model Documentation - IPAC-Global IPAC-Global
MARKAL-India full in preparation Model Documentation - MARKAL-India MARKAL-India
MEDEAS reference card only in preparation N/A MEDEAS
MERGE-ETL full in preparation Model Documentation - MERGE-ETL MERGE-ETL
MUSE full in preparation Model Documentation - MUSE MUSE
McKinsey reference card only in preparation N/A McKinsey
PRIMES reference card only in preparation N/A PRIMES
PROMETHEUS full under review Model Documentation - PROMETHEUS PROMETHEUS
TIAM-ECN full in preparation Model Documentation - TIAM-ECN TIAM-ECN
WITNESS full in preparation Model Documentation - WITNESS WITNESS

Publication policies of IAMC Documentation

  1. IAM models may participate in the IAMC wiki fully documented or with a documented reference card only. In the last case only the second and last bullet applies.
  2. Each model that wants to participate in the IAMC wiki is subject to the #IAMC documentation process flow
  3. The model documentation is organized in a prescribed #documentation tree. The model documentation must be ordered according this classification.
  4. Moving top-down through the documentation tree to the most detailed pages, all the pages on the way should have some text.
  5. At the start of documenting a model all possible pages are generated (REMARK: or just the mandatory pages...) . The info box at the right of each model documentation page enables you to navigate through the documentation pages. All 'not optional' pages in the documentation tree must be filled with some appropriate text. If a documentation entry is not applicable to your model, then put a short note, otherwise write here an introduction and more detailed documentation in the underlying level (if any).
  6. At the end of the documenting process the empty pages should be removed from the documentation tree (via More=>delete or ask the administrator)
  7. The reference card summarizes the features of each model. Every model must enter its features into the forms of the reference card. The comparison of the model documentation uses this information.

Documentation tree

Documentation is ordered in a structured tree. Each model documentation page belongs to a category from this tree, e.g. the page Energy - IMACLIM belongs to Category:Energy.

A category in the documentation tree may be optional. The as bold represented Documentation categories are not optional and must get some text .


Retrieved from "https://www.iamcdocumentation.eu/index.php?title=Model_publication_and_policies&oldid=11879"