Model Documentation - WITNESS: Difference between revisions
(Edited automatically from page WITNESS setup.) |
(v2 rewrite as stored in external repository after v1 mostly lost and no backup :-() |
||
| Line 1: | Line 1: | ||
{{ModelDocumentationTemplate | = Reference documentation = | ||
WITNESS reference documentation is located directly in the source GitHub repositories, in a "documentation" folder next to the source code for each discipline. | |||
Let's for example, consider the [[/github.com/os-climate/witness-core/tree/main/climateeconomics/sos wrapping/sos wrapping witness/population|population model]] | |||
[[File:Population github folder snapshot.png|alt=Population github folder snapshot|frameless|890x890px]] | |||
The documentation markup file can be displayed directly in the tool in the "Documentation tab" for each discipline: | |||
[[File:Population documentation in GitHub.png|alt=Population documentation in GitHub|none|thumb|578x578px|Population documentation in GitHub]] | |||
and will also be available in the tool in the "Documentation" tab for the discipline: | |||
[[File:Population documentation in SoSTrades.png|alt=Population documentation in SoSTrades|none|thumb|752x752px|Population documentation in SoSTrades]] | |||
References and links to academic papers / reference dataset used are listed at the end of these disciplines documentation pages. | |||
= Installation documentation = | |||
Installation documentation for standalone laptop installation can be found [[/sostrades-dev-tools.readthedocs.io/en/latest/installation.html|here]]. | |||
Local classical installation or as a Docker component is available for Linux, Mac and Windows. | |||
For a full cloud installation with DevSecOps of models, please contact the project [mailto:contact@sostrades.org here] :-) | |||
= Developer's documentation = | |||
A draft developer's documentation is available [[/sostrades-core.readthedocs.io/en/integration/|here]]. | |||
User and developer's MOOC are planned to be developed and will be hosted by Linux Foundation. | |||
= Support = | |||
Support sessions are organised for users ("Come as you are" sessions) and for developers ("Code as you are" sessions). | |||
Please check [[/www.witness4climate.org/events/|here]] for next sessions and registration.{{ModelDocumentationTemplate | |||
|IsDocumentationOf=WITNESS | |IsDocumentationOf=WITNESS | ||
|DocumentationCategory=Model Documentation | |DocumentationCategory=Model Documentation | ||
}} | }} | ||
Revision as of 16:41, 21 August 2024
Reference documentation
WITNESS reference documentation is located directly in the source GitHub repositories, in a "documentation" folder next to the source code for each discipline.
Let's for example, consider the population model
The documentation markup file can be displayed directly in the tool in the "Documentation tab" for each discipline:
and will also be available in the tool in the "Documentation" tab for the discipline:
References and links to academic papers / reference dataset used are listed at the end of these disciplines documentation pages.
Installation documentation
Installation documentation for standalone laptop installation can be found here.
Local classical installation or as a Docker component is available for Linux, Mac and Windows.
For a full cloud installation with DevSecOps of models, please contact the project here :-)
Developer's documentation
A draft developer's documentation is available here.
User and developer's MOOC are planned to be developed and will be hosted by Linux Foundation.
Support
Support sessions are organised for users ("Come as you are" sessions) and for developers ("Code as you are" sessions).
Please check here for next sessions and registration.
Note: The documentation of WITNESS is 'in preparation' and is not yet 'published'!| Corresponding documentation | |
|---|---|
| Previous versions | |
| No previous version available | |
| Model information | |
| Model link | |
| Institution | Open-Source for Climate (OS-C), N/A, https://os-climate.org/transition-analysis/., Linux Foundation (LF), N/A, https://www.linuxfoundation.org/. |
| Solution concept | Systems dynamics based approach |
| Solution method | OptimizationSimulation-based optimization |
| Anticipation | |