Model Documentation - WITNESS

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:

Population documentation in GitHub

and will also be available in the tool in the "Documentation" tab for the discipline:

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 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'!

Model Documentation - WITNESS
Appendices - WITNESS Mathematical model description - WITNESS Data - WITNESS References - WITNESS
Corresponding documentation
AIM-Hub BLUES C3IAM COFFEE-TEA DNE21+ GCAM GEM-E3 GRACE IFs IMACLIM IMAGE MESSAGE-GLOBIOM POLES PROMETHEUS REMIND-MAgPIE TIAM-UCL WITCH
Previous versions
No previous version available
Model information
Model link	https://www.witness4climate.org/world-environmental-impact-and-economics-scenarios/
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