Model Documentation - WITNESS

From IAMC-Documentation
Revision as of 15:41, 21 August 2024 by Thierry Chevalier (talk | contribs) (v2 rewrite as stored in external repository after v1 mostly lost and no backup :-()
Jump to navigation Jump to search

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 Population github folder snapshot The documentation markup file can be displayed directly in the tool in the "Documentation tab" for each discipline:

Population documentation in GitHub
Population documentation in GitHub

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

Population documentation in SoSTrades
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.

Alert-warning.png Note: The documentation of WITNESS is 'in preparation' and is not yet 'published'!

Model Documentation - WITNESS

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