Model Documentation - WITNESS: Difference between revisions
(v2 rewrite as stored in external repository after v1 mostly lost and no backup :-() |
No edit summary Tag: Manual revert |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ModelDocumentationTemplate | |||
|IsEmpty=No | |||
|IsDocumentationOf=WITNESS | |||
|DocumentationCategory=Model Documentation | |||
}} | |||
= Model presentations = | |||
Some videos of live presentations of WITNESS model are available on [https://www.witness4climate.org/witness-presentations/ witness4climate.org] website. | |||
= Reference documentation = | = 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. | WITNESS reference documentation is located directly in the [https://github.com/orgs/os-climate/repositories?q=witness source GitHub repositories], in a "documentation" folder next to the source code for each discipline. | ||
Let's for example, consider the [https://github.com/os-climate/witness-core/tree/main/climateeconomics/sos_wrapping/sos_wrapping_witness/population/ population model] folder in GitHub: | |||
[[File:Population github folder snapshot.png|alt=Population github folder snapshot|896x896px]] | |||
The documentation markup file can be displayed directly in the tool in the "Documentation tab" for each discipline: | 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]] | [[File:Population documentation in GitHub.png|alt=Population documentation in GitHub|none|thumb|578x578px|Population documentation in GitHub]] | ||
| Line 14: | Line 25: | ||
= Installation documentation = | = Installation documentation = | ||
Installation documentation for standalone laptop installation can be found [ | Installation documentation for standalone laptop installation can be found [https:///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. | Local classical installation or as a Docker component is available for Linux, Mac and Windows. | ||
| Line 21: | Line 32: | ||
= Developer's documentation = | = Developer's documentation = | ||
A draft developer's documentation is available [ | A draft developer's documentation is available [https:///sostrades-core.readthedocs.io/en/integration/ here]. | ||
User and developer's MOOC are planned to be developed and will be hosted by Linux Foundation. | User and developer's MOOC are planned to be developed and will be hosted by Linux Foundation. | ||
| Line 28: | Line 39: | ||
Support sessions are organised for users ("Come as you are" sessions) and for developers ("Code as you are" sessions). | Support sessions are organised for users ("Come as you are" sessions) and for developers ("Code as you are" sessions). | ||
Please check [ | Please check [https:///www.witness4climate.org/events/ here] for next sessions and registration. | ||
Latest revision as of 14:19, 19 December 2024
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 | |
Model presentations
Some videos of live presentations of WITNESS model are available on witness4climate.org website.
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 folder in GitHub:
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.